Getting Started

Getting started

Applies to all versions. The requirements differ per build (see below).

Installation

Armor Cosmetic must be installed on both the server and every client: the cosmetic inventory lives on the server and is synchronised to the players, and the client draws it.

1. Install the loader that matches your build (NeoForge, or Fabric Loader plus Fabric API).
2. Put the Armor Cosmetic JAR for your Minecraft version and loader in the mods folder.
3. Start the game. The config file is created on the first launch (see Configuration).

JAR names follow armor_cosmetic-<minecraft>-<loader>-<loader version>-<mod version>.jar, for example armor_cosmetic-26.3-fabric-0.19.5-1.0.0.jar.

Requirements

Build	Requires
NeoForge 1.21.1	Minecraft 1.21.x, NeoForge 21.1 or newer, Java 21
NeoForge 26.1.2 / 26.2 / 26.3	That exact Minecraft version and at least the NeoForge version of the build (see Home), Java 25
Fabric 1.21.1	Minecraft 1.21.1, Fabric Loader 0.19.5 or newer, Fabric API, Java 21
Fabric 26.1.2 / 26.2 / 26.3	That Minecraft version, Fabric Loader 0.19.5 or newer, Fabric API, Java 25

There are no other required mods. Corail Tombstone is optional and changes the death behaviour (see Death and storage).

First steps

1. Open your inventory (E).
2. Click the small cosmetic armor button next to the player preview to open the cosmetic inventory (you can also bind a key, see Cosmetic inventory).
3. Put armor, a carved pumpkin, a head or any other wearable item in the cosmetic slots. Other players now see that item instead of your real armor.

Building from source

The source of every build is on its branch of codex-skd/armor-cosmetic. Check out the branch and run:

./gradlew build

The JAR is written to build/libs/. Use Java 21 for the 1.21.1 branches and Java 25 for the 26.x branches.