Clockwork Aviation

Clockwork Aviation is a progression-centric modpack for Minecraft 1.21.1.

Installing

You can get release versions of the modpack from our Releases page.
Alternatively, if you want to help test the modpack, you can install from the trunk branch instead by downloading from our Actions page.

Developing

You'll need some prerequisites before you can make changes to the Clockwork Aviation modpack.
git - uv - packwiz
Additionally, I recommend a code editor of some variety. Visual Studio Code is a good, beginner-friendly option.

Installing Prerequisites

This section of the guide only applies to Windows systems. If you're on Linux, refer to the documentation of the projects listed above. We also offer a Nix Flake that contains all of the required prerequisites, if you're a Nix user.

git

You can download git from the git download page.

Alternatively, you can use winget:

winget install --id=Git.Git -e --source=winget

uv

You can install uv with the following Powershell command:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Alternatively, you can use winget:

winget install --id=astral-sh.uv -e

packwiz

You can download packwiz from nightly.link. Then, just extract the zip file, and put the packwiz.exe executable in your PATH.

Getting the Source Code

Once you have git installed, you can use the git clone command to get a copy of the repository on your system.

git clone https://c.csw.im/GalacticFactory/ClockworkAviation.git

Then, you can use uv to install the Python dependencies required for development.

uv sync --frozen

Finally, we use some git hooks to ensure that some stylistic conventions are met. I'm not going to thoroughly explain the hooks we use here, but a git hook is basically a script that is run automatically by git when you do a certain action, like committing changes. You can view all of the hooks we use in the .pre-commit-config.yaml file. This is optional, so if you don't trust the hooks we use, you can skip this step! Just make sure to run packwiz refresh manually before committing changes, to ensure you don't push an index file with incorrect hashes. Otherwise, you can install the git hooks with the following command:

uvx pre-commit install

Licensing

This modpack is licensed under the Open Software License 3.0 (OSL-3.0).

Please note:

• Individual mods, datapacks, and resource packs, henceforth referred to as "external components", included in this pack remain under their original licenses.
• This modpack does not alter or relicense external components.
• As this is a Packwiz-based modpack, external components are referenced via metadata files and downloaded from their original sources, unmodified and in accordance with their respective licenses.
  • This does not apply to distributions of the modpack uploaded to Modrinth. In that case, any external components that are not present on the Modrinth platform will be redistributed within the modpack artifact.
  • We maintain a list of all external components that are not contained within the Modrinth platform, which is located at PERMISSIONS.md.
• Any configuration files, scripts, datapacks, or other original content contained wholly within this repository are covered under the OSL-3.0.

By using or redistributing this modpack, you agree to comply with the license of the modpack itself as well as the licenses of each included component.