Skip to content

Commit d2e8d7c

Browse files
committed
Update BUILD.md to clarify JAR output paths and add release instructions for Fabric and NeoForge
1 parent d0cc6a5 commit d2e8d7c

File tree

2 files changed

+42
-24
lines changed

2 files changed

+42
-24
lines changed

BUILD.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,49 @@ From the project root:
88
./gradlew clean build
99
```
1010

11-
Output JARs:
11+
Output JARs (version comes from `gradle.properties``mod_version`):
1212

13-
- **Fabric:** `fabric/build/libs/skinmc_mod-fabric-1.0.0.jar`
14-
- **NeoForge:** `neoforge/build/libs/skinmc_mod-neoforge-1.0.0.jar`
13+
- **Fabric:** `fabric/build/libs/skinmc_mod-fabric-<version>.jar`
14+
- **NeoForge:** `neoforge/build/libs/skinmc_mod-neoforge-<version>.jar`
1515

16-
Use these exact files when copying to a mods folder.
16+
Use these exact files when copying to a mods folder. Do **not** use `-dev-shadow` or `-sources` JARs.
1717

18-
## If you get "non-static callback targets a static method"
18+
## Making a release (both Fabric and NeoForge)
1919

20-
The mixin callbacks are **static** in the source and in the built JAR. This error means the game is loading an **old** mod JAR that was built before the fix.
20+
1. **Set the version** in `gradle.properties`:
21+
22+
```properties
23+
mod_version = 2.0.0 # e.g. 2.0.0, 2.0.1, 2.1.0
24+
```
25+
26+
2. **Build both platforms** from the project root:
2127

22-
1. **Clean build**
2328
```bash
2429
./gradlew clean build
2530
```
2631

27-
2. **Use the new JAR**
28-
- Remove **any** existing `skinmc_mod` JAR from your mods folder.
29-
- Copy **only** the new file:
30-
- Fabric: `fabric/build/libs/skinmc_mod-fabric-1.0.0.jar`
31-
- NeoForge: `neoforge/build/libs/skinmc_mod-neoforge-1.0.0.jar`
32-
- Do not use `-dev-shadow` or `-sources` JARs.
32+
3. **Collect the release JARs** (no `-dev-shadow` or `-sources`):
33+
34+
- `fabric/build/libs/skinmc_mod-fabric-<version>.jar`
35+
- `neoforge/build/libs/skinmc_mod-neoforge-<version>.jar`
36+
37+
4. **Create the release** (e.g. on GitHub or your download page):
3338

34-
3. **If using Prism Launcher**
35-
- Update the mod in the instance: remove the old SkinMC mod, add the new JAR from the paths above (or replace the file in the instance’s `mods` folder).
39+
- Create a new release / tag (e.g. `v2.0.0`).
40+
- In the release notes, say which file is for Fabric and which for NeoForge.
41+
- Attach **both** JARs so users can download the one that matches their loader.
3642

37-
4. **If using Run Client from the IDE**
38-
- Use **Build → Rebuild Project** (or run `./gradlew clean :fabric:build`), then run the Fabric/NeoForge client again so it picks up the latest build.
43+
Example release text:
44+
45+
```text
46+
- **Fabric:** `skinmc_mod-fabric-2.0.0.jar` — use with Fabric loader.
47+
- **NeoForge:** `skinmc_mod-neoforge-2.0.0.jar` — use with NeoForge loader.
48+
```
49+
50+
5. **(Optional)** Commit the version bump before or after the release:
51+
```bash
52+
git add gradle.properties
53+
git commit -m "Release 2.0.0"
54+
git tag v2.0.0
55+
git push origin main --tags
56+
```

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,21 @@ Create your cape on SkinMC. Wear it in-game with the SkinMC Mod.
1111

1212
## Features
1313

14+
![SkinMC Mod Features](https://i.imgur.com/PuAYSru.gif "SkinMC Mod Features")
15+
1416
- Displays your SkinMC cape in-game in singleplayer and multiplayer
1517
- Choose how capes are shown: SkinMC overrides default capes, default only, or SkinMC only
1618
- Shift + right-click a player to open their SkinMC profile (optional, can be turned off)
1719
- Works on both **Fabric** and **NeoForge**
1820

1921
## Configuration
2022

21-
Settings are in **Mod Menu** (Fabric) or the mod list config button (NeoForge), under *SkinMC Cape Settings*. You can also edit `config/skinmc_mod.json`:
23+
Settings are in **Mod Menu** (Fabric) or the mod list config button (NeoForge), under _SkinMC Cape Settings_. You can also edit `config/skinmc_mod.json`:
2224

23-
| Option | Description |
24-
|--------|-------------|
25-
| **Cape display** | *SkinMC overrides (default)* — SkinMC capes replace Mojang/OptiFine capes when set; *Default only* — only show Mojang/OF capes; *SkinMC only* — only show SkinMC capes (hide default when no SkinMC cape) |
26-
| **Shift + right-click player** | When enabled, shift + right-clicking a player opens their SkinMC profile |
25+
| Option | Description |
26+
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27+
| **Cape display** | _SkinMC overrides (default)_ — SkinMC capes replace Mojang/OptiFine capes when set; _Default only_ — only show Mojang/OF capes; _SkinMC only_ — only show SkinMC capes (hide default when no SkinMC cape) |
28+
| **Shift + right-click player** | When enabled, shift + right-clicking a player opens their SkinMC profile |
2729

2830
## How to install it
2931

@@ -47,7 +49,6 @@ You can also create your own cape in the [SkinMC Cape Editor](https://skinmc.net
4749

4850
## Links
4951

50-
- **Cape editor:** https://skinmc.net/capes/editor
5152
- **Upload a cape:** https://skinmc.net/account/capes
5253
- **Discord:** https://skinmc.net/go/discord
5354

@@ -60,7 +61,6 @@ You can find a large selection of Minecraft capes on the following pages, or mak
6061
- [SkinMC Cape Editor](https://skinmc.net/capes/editor) — create your own custom cape
6162
- Feel free to add more here!
6263

63-
6464
## What format does it support?
6565

6666
Currently capes must be

0 commit comments

Comments
 (0)