Skip to content

Commit eec378f

Browse files
committed
Update readme to make things more obvious
1 parent a467130 commit eec378f

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,44 @@
22

33
[![powered by hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1)](https://github.com/hexdoc-dev/hexdoc)
44

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.
66

77
> [!CAUTION]
88
> **Do not fork or clone this repository** to set up a new mod! See the usage steps and FAQ for more details.
99
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+
1013
## Usage
1114

1215
1. Install the prerequisites:
1316
- [Git](https://github.com/git-guides/install-git)
1417
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
1518
- 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.
1720
> [!CAUTION]
1821
> **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:
2023
```sh
2124
uvx copier copy gh:FallingColors/hexdummy .
2225
```
23-
4. Set up your Python environment and lockfile:
26+
2. Set up your Python environment and lockfile:
2427
```sh
2528
uv sync
2629

2730
.\.venv\Scripts\activate # Windows
2831
. .venv/bin/activate.fish # fish
2932
source .venv/bin/activate # everything else
3033
```
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`):
3235
```
3336
git add .
3437
git update-index --chmod=+x gradlew
3538
git commit -m "Set up mod template"
3639
git push
3740
```
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:
4043
1. In your GitHub repository settings, create two new environments called `pypi` and `curseforge-modrinth`.
4144
2. Add the following environment secrets (**not** environment variables) to the `curseforge-modrinth` environment:
4245
- `CURSEFORGE_TOKEN`: Generate a new [CurseForge API token](https://authors-old.curseforge.com/account/api-tokens).

0 commit comments

Comments
 (0)