L1nkZ / Bourgeon

Bourgeon

Bourgeon is a C++17 library whose purpose is to provide an easy-to-use Python interface to implement plugins for Ragnarok Online clients.

Note: This is a work in progress.

Supported Clients

• 2015-11-04aRagexe
• 2017-06-14bRagexeRE
• 2019-01-16cRagexe

Requirements

• Python >= 3.5 (32-bit)
• CMake >= 3.4
• Visual Studio >= 2017

Clone and build

$ git clone https://github.com/L1nkZ/Bourgeon --recurse-submodules
$ cd Bourgeon
$ mkdir build && cd build
# You need to do "cmake .. -A Win32", if you're using Visual Studio 2019
# You may also need to use -DPYTHON_EXECUTABLE:FILEPATH="C:\Path\To\python.exe"
# if you have several version of Python installed (32 and 64 bit for example).
$ cmake ..
$ cmake --build . --config Release

Note: The project has to be built in Release mode for it work. This is required to ensure ABI compatibility of our C++ std objects' and those of the game client's.

How to use

• Build the module (ddraw.dll)
• Move the module to your Ragnarok folder
• Make sure python3x.dll is in your PATH or in your Ragnarok folder
• Create a folder named plugins in your Ragnarok folder and put your plugins into it
• Run your Ragnarok client

Plugins

• You can get a sense of how plugins work by consulting scripts located in the examples folder.
• When injected into a client, Bourgeon fetches plugins from the plugins subfolder. You should put your plugins into this folder if you want them to be loaded at runtime.