Skip to content

A Python toolkit to scan Minecraft source code and generate helper files for server owners and developers

License

Notifications You must be signed in to change notification settings

queengooborg/mc-toolkit

Repository files navigation

queengooborg's Minecraft Toolkit

A Python toolkit to scan Minecraft source code and generate helper files for server owners and developers.

This toolkit is designed to perform two main tasks:

  • Decompiles, deobfuscates and scans the Minecraft source code to generate a list of items and their associated recipes
  • Using the generated item data, create an EssentialsX worth.yml and a BossShopPro + BS-ItemShops set of shops

Developed and tested for 1.13 through 1.20.4.

Warning

Source mappings are obtained directly from Microsoft, and may change at any time, even for older Minecraft versions. Please be aware that this program may break as a result.

Need a worth.yml with all the new items? Check out my fork of X00LA's file! https://gist.github.com/queengooborg/92d08120f0d6d25175f6c7a30e3ccac7

Requirements

  • Java 8+
  • Python 3.7+
  • PyYAML (pip install pyyaml)
  • DecompilerMC (added as a submodule)

generate_items.py

This script generates an items.json file in the output/ folder, which contains a structured list of all the items and their crafting recipes.

Note: the crafting recipes are pulled directly from Minecraft's source code, and may include useless recipes or ingredient names that aren't actual blocks. This will be adjusted over time.

python3 generate_items.py [mc_version] (-n/--no_cache)

generate_worth.py

This script generates a worth.yml for the EssentialsX Bukkit/Spigot/Paper server plugin. This is used to generate https://gist.github.com/queengooborg/92d08120f0d6d25175f6c7a30e3ccac7.

python3 generate_worth.py [mc_version] (-n/--no_cache)

generate_shops.py

This script uses the worth.yml file generated by the above script and generates a series of configuration files for the BossShopPro + BS-ItemShops Bukkit/Spigot/Paper server plugin.

python3 generate_shops.py [mc_version] (-n/--no_cache)

About

A Python toolkit to scan Minecraft source code and generate helper files for server owners and developers

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages