minepkg companion mod

This fabric mod connects the minepkg CLI to Minecraft.

It currently enables minepkg to skip the main menu and immediately join a server or start a single player session.

Developer Notes

To build and test this mod, use the following workflow:

1. Build the mod and launch Minecraft using: minepkg launch --minepkgCompanion none. Optionally, specify a Minecraft version by adding -m <minecraft-version> to the command.
2. Create a world; call it, for example, test_world.
3. Set the environment variable: export MINEPKG_COMPANION_PLAY=local://test_world
4. Launch Minecraft again. The mod should now load the world on startup.

To test joining a server locally:

1. Start a server using: minepkg launch --minepkgCompanion none --server -a
2. In a separate terminal, set the environment variable: export MINEPKG_COMPANION_PLAY=server://localhost
3. Join the server with the client using: minepkg launch --minepkgCompanion none (note: both sessions need to run the same Minecraft version)

Troubleshooting

• Try building with ./gradlew clean build
• See if there are newer compatible versions of dependencies (Fabric Loom, Fabric Loader, Gradle)
• Make sure you have the correct java version. (java --version)
• Ask for help on the minepkg Discord server

License

This mod is MIT licenced.