The Minecraft maven plugin allows its users to easily apply patches to the Minecraft server or client using maven's well established build management.
- Maven 2+
- Git in the executing shell's PATH
<pluginRepositories>
<pluginRepository>
<id>basin</id>
<name>Basin</name>
<url>https://www.basinmc.org/nexus/repository/maven-releases/</url>
</pluginRepository>
</pluginRepositories>For an example configuration, refer to the Example Project.
| Property | Type | User Property | Default | Purpose |
|---|---|---|---|---|
| gameVersion | String | N/A | N/A | Specifies the vanilla game version to retrieve and patch. |
| mappingVersion | String | N/A | N/A | Specifies the MCP version to download and apply. |
| module | String | N/A | N/A | Indicates which module (server or client) is going to be built against. |
| patchDirectory | File | N/A | ${project.basedir}/src/minecraft/patch | Specifies where the patches will be pulled from/written to. |
| sourceDirectory | File | N/A | ${project.basedir}/src/minecraft/java | Specifies where the decompiled and patched Minecraft sources will be stored. |
| resourceDirectory | File | N/A | ${project.build.directory}/generated-sources/minecraft | Specifies where the non-code resources will be stored. |
| accessTransformation | File | N/A | N/A | Indicates whether there is and where to locate an Access Transformation configuration. |
| force | Boolean | minecraft.force | false | Indicates whether the git safeguard shall be skipped. |
| Goal | Phase | Purpose |
|---|---|---|
| safeguard | Validate | Ensures all changes to the source were commited and turned into a respective patch file to avoid accidental loss of changes. |
| fetch-module | Initialize | Fetches a vanilla Minecraft artifact and caches it. |
| fetch-mappings | Initialize | Fetches MCP and SRG mappings and caches them. |
| apply-mappings | Initialize | Generates a mapped Minecraft artifact and caches it. |
| decompile-module | Initialize | Generated a source Minecraft artifact and caches it. |
| initialize-repository | Generated Sources | Extracts a Minecraft source artifact and adds them to a local git repository. |
| extract-resources | Generated Resources | Extracts all non-code Minecraft sources. |
| apply-patches | Generate Sources | Applies all patches within the patches directory to the local git repository. |
| generated-patches | Generate Sources | Re-generates patches based on the commit history within the local git repository. |
Generally it is recommended to set resourceDirectory to a value which is cleaned automatically in
order to indicate to other developers that modifications to these files will be overridden.
In addition all users should configure their IDEs to be able to execute
the org.basinmc.maven.plugins:minecraft-maven-plugin:generate-patches goal from within their
project directory in order to re-generate their patches from changes made and commited in the source
directory.
This plugin wouldn't be possible without the great people bind MCP Bot who provide access to the most recent version of MCP as well as the CSRG mappings for the game. We've been searching for mappings that fit our needs for quite a bit and this solution is by far the most outstanding.
The official documentation has help articles and specifications on the implementation. If, however, you still require assistance with the application, you are welcome to join our IRC Channel and ask veteran users and developers. Make sure to include a detailed description of your problem when asking questions though:
- Include a complete error message along with its stack trace when applicable.
- Describe the expected result.
- Describe the actual result when different from the expected result.
See CONTRIBUTING.md for information on working on minecraft-maven-plugin and submitting patches. You can also join the project's chat room to discuss future improvements or to get your custom implementation listed.
IRC: irc.basinmc.org (port 6667 or port +6697) in #Basin
Website: https://www.basinmc.org