Skip to content

Installation

This wiki documents the Fabric build for Minecraft 1.21.1, using Java 21 and targeting Cobblemon 1.8.4. Use the matching GreatNPC build on the server and on clients that use its custom interfaces.

Requirements

Component Requirement
Minecraft 1.21.1
Mod loader Fabric Loader 0.18.3 or newer
Java 21 or newer compatible with the chosen Minecraft/modpack runtime
Fabric API Build for Minecraft 1.21.1
Fabric Language Kotlin Compatible build for the installed Cobblemon/GreatNPC dependencies
Cobblemon This documented build targets Fabric 1.8.4 for Minecraft 1.21.1
GreatNPC The built distribution JAR, not its -sources.jar

The mod metadata currently permits Cobblemon >=1.8.0. That metadata floor is not a claim that every newer Cobblemon version is tested. The current Gradle dependency is 1.8.4+1.21.1.

Libraries already inside the distribution

The release build bundles these libraries through jar-in-jar:

  • RCT API 0.16.1-beta for Fabric 1.21.1.
  • Architectury Fabric 13.0.8.
  • Fabric Permissions API 0.3.1.
  • SQLite JDBC 3.45.2.0 and MariaDB JDBC 3.5.3.

Do not add another copy of a bundled library just because it appears as a required dependency in a loader message or in a feature description. If another modpack component already manages that library, check the resolved versions instead of installing duplicate or conflicting JARs.

Fabric API, Fabric Language Kotlin, and Cobblemon are not bundled by GreatNPC and must be supplied by the instance/modpack.

Install on a client or single-player instance

  1. Prepare a Fabric Minecraft 1.21.1 instance using a Java 21 runtime.
  2. Install Fabric API, Fabric Language Kotlin, and Cobblemon for that instance.
  3. Add the GreatNPC distribution JAR to the instance's mods folder.
  4. Launch the game and check that Fabric resolves the dependencies.
  5. Open a disposable creative test world before editing an existing map.
  6. Create your first NPC.

Keep only the intended GreatNPC version in the folder. A sources JAR is for reading code and is not the playable distribution.

Install on a dedicated server

  1. Stop the server and make a complete backup.
  2. Confirm that it runs Fabric Minecraft 1.21.1 on Java 21.
  3. Install the external dependencies and GreatNPC in the server's mods folder.
  4. Start the server and inspect logs/latest.log for loading/configuration errors.
  5. Grant builders the relevant permissions, or test as an operator.
  6. Install the matching client mod/dependencies for players who need GreatNPC's screens.

The server owns trainer configuration, placed entities, battle rules, history, and trade state. The client provides the custom NPC editor, shop, preset manager, trainer menu, and visual behavior. A resource pack alone does not supply those client screens.

/trainers has a chat-list fallback when the GreatNPC menu channel is unavailable. This fallback does not make the custom editor or shop available to an unmodded client.

Optional integrations

LuckPerms can provide permission-node management. Placeholder API can supply additional placeholder integration where supported. These are optional suggestions, not mandatory replacements for the bundled permission library.

Optional compatibility code also exists for GeckoLib armor and Mega Showdown features. Only enable/test those features with the corresponding compatible mods installed; they are not required to create a basic NPC.

Check the installation

In a creative test world, run:

/give @s greatnpc:humanoid_egg
/give @s greatnpc:edit_stick

Spawn an NPC with the egg and right-click it with Edit NPC. A successful dependency load followed by an accessible editor is a useful initial smoke test. It does not verify every battle integration, remote skin host, or custom resource pack.

If the tools are denied, check greatnpc.tools and editing permissions. If the custom GUI cannot open, check that GreatNPC is present on the client as well as the server.

See Updating and backups before replacing a build on a live server.