Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 2.74 KB

README.md

File metadata and controls

43 lines (25 loc) · 2.74 KB
Raw

PickHaxe

PickHaxe is a flexible, powerful Haxe framework to supercharge your Minecraft mod development. Build your mods in a high-level strictly-typed language and export to the Minecraft version and modding API of your choice.

Getting started is simple. Install Haxe and PickHaxe, then create a new mod project (or download a sample project) and get developing. When you're ready to test, PickHaxe will compile your mod for any of several several versions of Minecraft on multiple different mod loaders. PickHaxe currently supports Fabric 1.16.5-1.20.2, as well as Forge 1.18.2-1.20.2, and all your code can be shared in a single project!

Usage

Download PickHaxe via haxelib:

haxelib install pickhaxe
haxelib run pickhaxe help

Please see the tutorial on the wiki for more information on basic usage.

Also see the available sample projects, available in their own repo.

Support

If you have a question, please head to one of the official discussion areas:

Contributing

Contributions are highly welcome and greatly appreciated. See CONTRIBUTING.md for more information.

License

PickHaxe's tools and APIs are made available under the MIT License. See LICENSE.md for more details.

PickHaxe's sample projects are made available under the LGPLv3 License. See LICENSE.md for more details.

PickHaxe's Minecraft API is generated from official mapping names from Mojang for fields and methods in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this license. For the latest license text, refer to the mapping file itself, or the reference copy here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md

PickHaxe's Minecraft API includes documentation generated from the Parchment mappings, which are made available under a CC0 1.0 Universal license. See LICENSE.txt for more details.

PickHaxe interoperates with the Fabric mod loader and the Forge mod loader respectively; these are licensed under the Apache v2 and LGPL licenses, respectively.