Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elitemastereric/pickhaxe
Develop Minecraft mods using Haxe.
https://github.com/elitemastereric/pickhaxe
fabric forge haxe minecraft minecraft-mod
Last synced: 24 days ago
JSON representation
Develop Minecraft mods using Haxe.
- Host: GitHub
- URL: https://github.com/elitemastereric/pickhaxe
- Owner: EliteMasterEric
- License: mit
- Created: 2023-03-06T07:56:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T12:22:05.000Z (4 months ago)
- Last Synced: 2024-08-22T13:54:39.159Z (4 months ago)
- Topics: fabric, forge, haxe, minecraft, minecraft-mod
- Language: Haxe
- Homepage:
- Size: 24.6 MB
- Stars: 53
- Watchers: 3
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://lib.haxe.org/p/PickHaxe/):
```
haxelib install pickhaxe
haxelib run pickhaxe help
```
Please see the [tutorial](https://github.com/EliteMasterEric/PickHaxe/wiki/Tutorial%253A-Your-First-Mod) on the wiki for more information on basic usage.
Also see the available [sample projects](https://github.com/EliteMasterEric/PickHaxe-Samples/), available in their own repo.
# Support
If you have a question, please head to one of the official discussion areas:
- The [PickHaxe Discussions](https://github.com/EliteMasterEric/PickHaxe/discussions) page.
- The [forum thread](https://discord.com/channels/162395145352904705/1085695464466296932) on the official Haxe Discord.
- The [Issues tab](https://github.com/EliteMasterEric/PickHaxe/issues).
# Contributing
Contributions are highly welcome and greatly appreciated. See [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
# License
PickHaxe's tools and APIs are made available under the MIT License. See [LICENSE.md](/LICENSE.md) for more details.
PickHaxe's sample projects are made available under the LGPLv3 License. See [LICENSE.md](https://github.com/EliteMasterEric/PickHaxe-Samples/blob/master/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](https://parchmentmc.org/), which are made available under a CC0 1.0 Universal license. See [LICENSE.txt](https://github.com/ParchmentMC/Parchment/blob/versions/1.20.x/LICENSE.txt) for more details.
PickHaxe interoperates with the [Fabric](https://fabricmc.net/) mod loader and the [Forge](https://github.com/MinecraftForge/MinecraftForge) mod loader respectively; these are licensed under the Apache v2 and LGPL licenses, respectively.