bakkesmodorg / BakkesModSDK

The current BakkesModSDK (Unofficial SDK for Rocket League)

Home Page:http://bakkesmod.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BakkesModSDK

BakkesMod is a mod for Rocket League initially built as an enhancement for freeplay. Over time it has grown and now it features enhancements such as a dollycam, variance options to the ingame custom trainer, multiplayer game hosting, POV goal replays and much more.

BakkesMod also provides a software development kit/API which interfaces with Rocket League. For now it is mostly used for creating freeplay trainings and replay enhancements (such as analysis tools). The plan is to also extend the SDK so (limited) information can be retrieved from online games, which can be used to for example keep track of advanced statistics during gameplay.

Examples of plugins that are embedded with the mod when it is installed can be found here. The dollycam plugin is also open source and can be found here

To get started using BakkesMod, simply go to http://bakkesmod.com and download the injector. If you wish to create plugins for the mod follow the steps that are described further down this page.

Currently the SDK is being extended to make it easier for plugin developers to create their own multiplayer gamemodes/training scenarios. BakkesMod has the ability to host an online game server which other players can connect to. For now only freeplay is supported but support for Team soccar/rumble is being added. Simply type "host" in the BakkesMod console to host a game, other players need to type "connect 127.0.0.1" to connect to your server (where 127.0.0.1 is your IP of course). In order for this to work you need to have forwarded port 27016 or use an utility such as Hamachi to emulate a LAN environment.

Getting started

In order to create plugins for Rocket League with BakkesMod you need the SDK. By default the SDK will be included with the BakkesMod installation and can be found in %appdata%\bakkesmod\bakkesmod\bakkesmodsdk. You could also simply clone this repository as this also contains the full SDK and is often more up to date.

IDE

To get started quickly, check out the template to automatically generate a project skeleton. In order to load your plugin ingame make sure the generated .dll is placed in the plugins folder of BakkesMod. Next, in Rocket League open the console and type plugin load filename (without the .dll extension!). To unload your plugin you can use plugin unload filename. Any cvars/notifiers/drawables that are registered when a plugin is loaded are automatically removed when a plugin is unloaded, so you don't have to worry about that!

Command Line

You'll still need to have Visual Studio installed for its included compilers.

  1. Open x64 Native Tools Command Prompt for VS 2019.
  2. Replace the paths to bakkesmodsdk below with the correct ones for your system and plugin.cpp with the actual name of the plugin.
cl /LD -I bakkesmodsdk/include/ bakkesmodsdk/lib/pluginsdk.lib plugin.cpp

Help & more info

If you have any questions feel free to drop by the BakkesMod programming discord. This discord is also full of many tutorials on how to get started.

About

The current BakkesModSDK (Unofficial SDK for Rocket League)

http://bakkesmod.com


Languages

Language:C++ 95.5%Language:C 4.3%Language:Python 0.3%