|
2 | 2 |
|
3 | 3 | [](https://github.com/hexdoc-dev/hexdoc) |
4 | 4 |
|
5 | | -This is an up-to-date, minimal, opinionated template for starting a multiloader Hex Casting addon on 1.20.1 with Architectury. Includes all necessary dependencies on both Forge and Fabric loaders, plus some demo bits. |
| 5 | +This is an up-to-date, minimal, opinionated template for starting a **multiloader, Kotlin-based** Hex Casting addon on 1.20.1 with Architectury. Includes all necessary dependencies on both Forge and Fabric loaders, plus some demo bits. |
6 | 6 |
|
7 | 7 | > [!CAUTION] |
8 | 8 | > **Do not fork or clone this repository** to set up a new mod! See the usage steps and FAQ for more details. |
9 | 9 |
|
| 10 | +> [!TIP] |
| 11 | +> If you're writing a Fabric-only or Forge-only mod, you probably don't need this template. Consider using the [Fabric template mod generator](https://fabricmc.net/develop/template/) or [Forge MDK](https://docs.minecraftforge.net/en/1.20.1/gettingstarted/) instead. |
| 12 | +
|
10 | 13 | ## Usage |
11 | 14 |
|
12 | 15 | 1. Install the prerequisites: |
13 | 16 | - [Git](https://github.com/git-guides/install-git) |
14 | 17 | - [uv](https://docs.astral.sh/uv/getting-started/installation/) |
15 | 18 | - Any IDE with Java and Kotlin support (recommended: [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/?section=windows)) |
16 | | -2. Create, clone, and enter a **new** GitHub repo. |
| 19 | +2. Create, clone, and enter a **new** GitHub repo. You don't need to use any other project templates (e.g. IntelliJ's Minecraft mod template) with HexDummy. |
17 | 20 | > [!CAUTION] |
18 | 21 | > **Do not** fork/clone/copy this repo directly. |
19 | | -3. From the repo root, run this command to copy the template, then follow the prompts to set it up: |
| 22 | +1. From the repo root, run this command to copy the template, then follow the prompts to set it up: |
20 | 23 | ```sh |
21 | 24 | uvx copier copy gh:FallingColors/hexdummy . |
22 | 25 | ``` |
23 | | -4. Set up your Python environment and lockfile: |
| 26 | +2. Set up your Python environment and lockfile: |
24 | 27 | ```sh |
25 | 28 | uv sync |
26 | 29 |
|
27 | 30 | .\.venv\Scripts\activate # Windows |
28 | 31 | . .venv/bin/activate.fish # fish |
29 | 32 | source .venv/bin/activate # everything else |
30 | 33 | ``` |
31 | | -5. Look through the generated project to make sure everything looks good, then add, commit, and push the generated files (including `uv.lock`): |
| 34 | +3. Look through the generated project to make sure everything looks good, then add, commit, and push the generated files (including `uv.lock`): |
32 | 35 | ``` |
33 | 36 | git add . |
34 | 37 | git update-index --chmod=+x gradlew |
35 | 38 | git commit -m "Set up mod template" |
36 | 39 | git push |
37 | 40 | ``` |
38 | | -6. Follow the [hexdoc setup instructions](https://hexdoc.hexxy.media/docs/guides/deployment/github-pages) for GitHub Pages. |
39 | | -7. Set up the release workflow: |
| 41 | +4. Follow the [hexdoc setup instructions](https://hexdoc.hexxy.media/docs/guides/deployment/github-pages) for GitHub Pages. |
| 42 | +5. Set up the release workflow: |
40 | 43 | 1. In your GitHub repository settings, create two new environments called `pypi` and `curseforge-modrinth`. |
41 | 44 | 2. Add the following environment secrets (**not** environment variables) to the `curseforge-modrinth` environment: |
42 | 45 | - `CURSEFORGE_TOKEN`: Generate a new [CurseForge API token](https://authors-old.curseforge.com/account/api-tokens). |
|
0 commit comments