crafthippie/bromance repository overview

⁠Bromance

This repository provides the whole configuration for the Bromance Minecraft mod pack. It's used to automatically build and publish the required files for Modrinth⁠ and the Curseforge Client⁠, and to publish a Docker image for the server on DockerHub⁠. Some information and documentation about this pack can be found on https://crafthippie.github.io/bromance⁠.

⁠Versions

To see the available Docker image versions it's best to look at https://hub.docker.com/r/crafthippie/bromance/tags⁠ while you can see the available files for the client at https://dl.webhippie.de/#minecraft/bromance/⁠.

⁠Volumes

• /var/lib/minecraft
• /etc/minecraft/override

⁠Ports

• 25565
• 25575
• 8123

⁠Available environment variables

MINECRAFT_BACKUPS_DIR = ${MINECRAFT_DATA_DIR}/backups

⁠Inherited environment variables

• webhippie/minecraft-vanilla⁠
• webhippie/temurin⁠
• webhippie/ubuntu⁠

⁠Development

We use mise⁠ to manage all required tools and their versions. Install it by following the official installation instructions⁠, then run the following commands inside the repository to activate mise and install all tools defined in mise.toml:

mise trust
mise install

⁠Contributing

Generally we are following conventional commits⁠ when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning⁠ which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

prek install --hook-type pre-commit --hook-type commit-msg

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

⁠Authors

• Thomas Boerger⁠

⁠License

MIT

⁠Copyright

Copyright (c) 2021 Thomas Boerger <http://www.webhippie.de>