DOCSEARCHbyAlgolia
Submit Docs

BakkesMod SDK

repository·master·Indexed 43 days ago

https://github.com/bakkesmodorg/bakkesmodsdk

A software development kit for creating Rocket League plugins to enhance gameplay, create custom training scenarios, and build analysis tools.

Tokens
464
Snippets
2
Records
4
Agent score
5%

What's inside BakkesModSDK

  1. Host and connect to a BakkesMod game server

    master

    BakkesMod can host online game servers (currently supporting Freeplay, with Team Soccar/Rumble support being added).

    • To host: Type host in the BakkesMod console.
    • To connect: Other players must type connect <IP_ADDRESS> in their console (e.g., connect 127.0.0.1).

    Requirements: You must have port 27016 forwarded or use a utility like Hamachi to emulate a LAN environment.

  2. Compile a plugin via Command Line

    master

    To compile a plugin manually using the MSVC compiler, you must have Visual Studio installed.

    1. Open the x64 Native Tools Command Prompt for VS 2019 (or your version of VS).
    2. Run the cl command, ensuring you replace the paths to bakkesmodsdk and the name of your plugin.cpp file with your actual local paths and filenames.
    cl /LD -I bakkesmodsdk/include/ bakkesmodsdk/lib/pluginsdk.lib plugin.cpp

  3. Load and unload plugins in Rocket League

    master

    After building your plugin, place the generated .dll file into the BakkesMod plugins folder.

    To manage your plugin while in Rocket League, use the in-game console:

    • To load: Type plugin load <filename> (do not include the .dll extension).
    • To unload: Type plugin unload <filename>.

    Note: Any cvars, notifiers, or drawables registered by your plugin are automatically cleaned up by BakkesMod when the plugin is unloaded.

    plugin load filename
plugin unload filename

  4. Install and get started with BakkesModSDK

    master

    To use BakkesMod, download the injector from http://bakkesmod.com.

    To develop plugins, you need the SDK. You can obtain the SDK in two ways:

    1. Local Installation: The SDK is included with your BakkesMod installation at %appdata%\bakkesmod\bakkesmod\bakkesmodsdk\.
    2. Repository Clone: Clone this repository to get the full SDK, which is often more up to date than the local installation.