Installation & Module 📦

✨ Since Version 6.x

Easy NPC is now split into multiple modules to provide flexibility for different use cases. This modular approach allows servers, modpacks, and developers to install only what they need.

🧩 Module Overview

Easy NPC consists of three separate modules:

Easy NPC: Bundle

The Bundle is the all-in-one package that includes both Core and Configuration UI modules. This is the recommended option for most players.

• ✅ Includes Easy NPC: Core
• ✅ Includes Easy NPC: Configuration UI
• 🎮 Best for: Regular players, single-player worlds, and simple setups
• 📥 Download: CurseForge | Modrinth

Easy NPC: Core

The Core module contains the foundational NPC logic and functionality. It's lightweight and perfect for server environments and mod development.

• ⚙️ Contains: All NPC systems, commands, presets, trading, dialogs, actions, API
• 🚫 Does NOT contain: Configuration UI (graphical interface)
• 🎯 Best for: Servers, modpack developers, mod development (creating NPCs programmatically), headless setups, API usage
• 📥 Download: CurseForge | Modrinth

Easy NPC: Configuration UI

The Configuration UI module adds the graphical user interface for configuring NPCs.

• 🖥️ Contains: All configuration screens and UI elements
• ⚠️ Requires: Easy NPC: Core to function
• 🔄 Required on: Both server AND client (server-client communication required)
• 🎯 Best for: Players who need GUI-based configuration with Core module
• 📥 Download: CurseForge | Modrinth

📋 Installation Options

Option A: Using a Launcher (Recommended)

Most modern Minecraft launchers support automatic dependency resolution.

1. Install Easy NPC: Bundle via your launcher (CurseForge, Modrinth, etc.)
2. The launcher will automatically download and install:
   • Easy NPC: Core
   • Easy NPC: Configuration UI
3. Launch the game and enjoy!

Supported launchers with automatic dependency resolution:

• CurseForge App
• Modrinth App

⚠️ Note: We primarily provide bug support for CurseForge and Modrinth launchers, as we cannot test all available launchers. Other launchers may work but are not officially tested or supported.

Option B: Manual Installation

If you're installing mods manually:

For Players (Full Experience):

1. Download Easy NPC: Core
2. Download Easy NPC: Configuration UI
3. Place both .jar files in your mods folder
4. Launch the game

For Servers (Command-Only):

1. Download Easy NPC: Core
2. Place the .jar file in your server's mods folder
3. Start the server
4. Configure NPCs using commands only

For Servers with GUI Access:

1. Server: Install Easy NPC: Core and Easy NPC: Configuration UI
2. Clients: Install Easy NPC: Core and Easy NPC: Configuration UI
3. Players can use the GUI to configure NPCs (both modules required on server and client for proper communication)

Option C: Modpack Installation

For Modpack Creators:

Choose based on your modpack's needs:

• Include Bundle: Easiest for players, all features included
• Include Core + Config UI: More control, same functionality
• Include Core Only: For adventure maps where NPCs are pre-configured

When creating a modpack, ensure the required modules are in your modpack's mods folder. Players copying the modpack should copy the entire mods folder to ensure all dependencies are present.

🎥 Video Tutorial

A comprehensive video tutorial explaining the modular system and installation process is available:

[Tutorial Video] (Coming Soon)

🔄 Upgrading from 5.x to 6.x

⚠️ Important: Version 6.x is a complete rewrite and is not compatible with 5.x data.

Key changes:

• Modular structure (Bundle/Core/Config-UI split)
• NPCs now extend vanilla entities instead of custom entities
• Data format changes
• Improved performance and optimization

See the Upgrading Guide for detailed migration information.

❓ Frequently Asked Questions

Do I need all three modules?

No! The Bundle includes everything. Alternatively:

• Core only = No GUI, commands only
• Core + Config UI = Full functionality

Can I use Core on the server and Config UI on clients?

No! The Configuration UI requires server-client communication and must be installed on both sides:

• Server: Install Core + Config UI
• Clients: Install Core + Config UI

For command-only servers, install Core only on the server.

What happened to the jar-in-jar bundle?

The old jar-in-jar approach caused compatibility issues with separate module installations. Version 6.x uses proper dependencies instead, making the mod more flexible and compatible.

Which module do I need for my use case?

Use Case	Required Modules
Single Player	Bundle (or Core + Config UI)
Multiplayer Server (with GUI)	Core + Config UI (server) + Core + Config UI (clients)
Multiplayer Server (command-only)	Core only (server)
Modpack Development	Bundle or Core + Config UI
Mod Development / API Usage	Core only

🆘 Troubleshooting

"Missing Easy NPC Core" error

You installed Config UI without Core. Install Easy NPC: Core as well.

"Configuration screen not opening"

You only have Core installed. Install Easy NPC: Configuration UI for GUI access, or use commands instead.

Launcher doesn't download dependencies

Try manual installation or switch to a launcher that supports automatic dependencies (CurseForge App, Modrinth App).