This project is obsolete and has been abandoned. Use ForgeGradle.
mcpackage is used to compile, obfuscate, and package Minecraft Mods by using Forge and MCP. Its primary use is to build and package PyMod and any other mods depending on PyMod for Minecraft.
This is still under development, not necessarily stable, lacks formal documentation, and has no examples.
- Refactor "build" command.
- Create "install" command to copy jar to minecraft directory.
- Create "run" command to run minecraft using proper Forge profile.
- Tutorial for how to build and package pymod.
- Make sure Python 3 and Jython 2.7 are fully supported.
- Make sure Windows is supported.
- Generate documentation.
- https://github.com/MinecraftForge/FML/wiki/FML-mod-information-file
- Document Jython installation:
- Later:
- Make "init" command interactive.
- Make sure Mac is supported.
TODO: Copy how to build PyMod.
mcpackage is licensed under the Mozilla Public License Version 2.0. See LICENSE or the FAQ for more information.
In summary, you may use mcpackage with any closed or open source project without affecting the license of the larger work so long as you:
- give credit where credit is due,
- and release any custom changes made to mcpackage.
The source code for mcpackage is available from the GitHub repo cpburnz/minecraft-mod-package.
Required Python Modules:
- setuptools for installation.
- PyYAML for configuration files.
- pathspec for file pattern matching.
Additional Requirements for making Python Minecraft Mods:
- Java
- Jython
Required Development Environment:
- Forge (TODO: DOCUMENT USE)
- MCP (TODO: DOCUMENT USE)
mcpackage can be installed from source with:
python setup.py install
TODO