https://github.com/pmmp/bds-modding-devkit

Auxiliary scripts used for modding BDS for generating protocol data
https://github.com/pmmp/bds-modding-devkit

Last synced: 3 months ago
JSON representation

Auxiliary scripts used for modding BDS for generating protocol data

• Host: GitHub
• URL: https://github.com/pmmp/bds-modding-devkit
• Owner: pmmp
• License: lgpl-3.0
• Created: 2022-02-02T22:08:53.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-27T10:58:15.000Z (4 months ago)
• Last Synced: 2024-09-27T09:43:23.439Z (3 months ago)
• Language: Shell
• Size: 82 KB
• Stars: 31
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bds-modding-devkit

This developer kit allows you to quickly and easily start modding the Bedrock Dedicated Server.

It's used for dumping information for protocol updates for PocketMine-MP, but the tools provided here can be used for much more than that.

The following mods are included as git submodules:

- [minecraft-linux/server-modloader-coremod](https://github.com/minecraft-linux/server-modloader-coremod)

- [pmmp/bds-mod-mapping](https://github.com/pmmp/bds-mod-mapping)

## Things you'll need

- A Linux environment with a 5.4 kernel or newer (WSL2 is fine)

- `python3`

- `pip`

- `clang`

- `libc++-dev`

- `libc++abi-dev`

- [LIEF](https://github.com/lief-project/LIEF): `python3 -m pip install lief~=0.14.0` (note: lief >=0.15.0 is currently NOT supported)

- [Frida](https://frida.re): `python3 -m pip install frida frida-tools`

- A folder or zip of [Bedrock Dedicated Server](https://minecraft.net/download/server/bedrock)

## Getting started in 60 seconds

1. Clone the repo

2. `git submodule update --init`

3. `./scripts/setup path/to/bds/server/files` or `./scripts/setup path/to/bds.zip`

4. `./start.sh` to run the server with mods loaded

Run `./helper.sh help` to get more usage info.

## Things in the repo

| File name | Description |

|:----------|:------------|

| `export-symbols.py` | Uses [LIEF](https://github.com/lief-project/LIEF) to patch BDS and make the symbols linkable |

| `helper.sh` | Helper script based on [modloader-helper](https://github.com/Frago9876543210/modloader-helper) |

| `start.sh` | Runs the server with mods loaded. From [modloader-helper](https://github.com/Frago9876543210/modloader-helper) |

| `tracer.py` | Uses [Frida](https://frida.re) to hook packet functions in BDS and create packet traces. Run this while you have a BDS instance already running. Requires `sudo`. |

## Adding your own mods

Mod code is placed in the `code` directory. Build them by invoking `./scripts/build all`.

To generate skeleton files for a new mod, use the tool `./scripts/gen`.

## Credits

- [@Frago9876543210](https://github.com/Frago9876543210)

  - Writing [modloader-helper](https://github.com/Frago9876543210/modloader-helper)

  - Writing the original version of [mapping](https://github.com/pmmp/mapping)

  - Revamping `tracer.py` ([gist](https://gist.github.com/Frago9876543210/2e5de55f1bb7e42594b73f5665391bf4#file-tracer-py))

- [@MCMrARM](https://github.com/MCMrARM)

  - Creating [server-modloader](https://github.com/minecraft-linux/server-modloader), without which this endeavour would simply not be possible.

  - Writing `export-symbols.py`

- [@Intyre](https://github.com/Intyre)

  - Helping me to write the initial versions of `tracer.py` which are still used today