blaku-rl / MapExpansionPlugin

1 stars 0 forks source link

MapExpansionPlugin

This plugin is aimed at adding features for map makers by utilizing the power of bakkes mod via Kismet

Features

How It Works

This plugin funtions by reading the contents of specifically named string kismet variables. Those variables are: bmcommand bmlog mepcommand. Each one serves a different purpose as described below. To make use of them, set the value the string that you'd like to use. For example to use the ballontop command from bakkes mod, set the bmcommand string to: ballontop. Each physics tick, the plugin will read the values of each of the specified named kismet strings and will try to run their commands. After it has processed the command, the plugin will set the value of the string to an empty string.

Building MEP

MEP is fairly simple to build, you'll just need a couple requirements.

Open the project in visual studio, make sure you are in release mode, and click build. If you have vcpkg setup, it should install nlohmann and link properly.

Bakkes Mod Console Commands

To run console commands, make a string var called bmcommand and set the value to the command that you would like to run You can find the available console commands that can be run here

Console Logging

To log information to the console, make a string var called bmlog and set the value to the information to be logged

Kismet Check For Plugin

To be notified when the plugin is loaded, make a remote event named MEPLoaded. When RL loads the map, the plugin will trigger this remote event. Additionally if the plugin is loaded/installed while the map is already opened, it will trigger this remote event then.

Custom Commands

Custom commands are self implemented and requested features for map makers to utilize when the bakkes mod commands just won't cut it. To run custom commands, make a string var called mepcommand and set the value to one of the custom commands listed below. You can chain multiple commands together by separating them with a semicolon.

Custom Command List