Overview
The SimpleCloud NPCs plugin allows you to create interactive NPCs on your server that enable players to access other subservers and perform various actions.
This plugin requires a supported third-party NPC plugin such as Citizens or
FancyNpcs to function. The SimpleCloud NPCs plugin adds SimpleCloud
functionality to NPCs created by these third-party plugins.
Supported Software
| Server Type | Plugin Support |
|---|
| Paper & Forks | ✅ Yes |
| Spigot & Forks | ✅ Yes |
| Other | ❌ No |
Quick Setup
- Download the SimpleCloud NPCs plugin from GitHub
- Download and install one of the supported NPC plugins (e.g., Citizens)
- Place both plugins in your server’s plugins folder
- Start your server
- Create an NPC using the third-party plugin’s commands
- Use the SimpleCloud NPCs commands to add SimpleCloud functionality to the created NPC
Required NPC Plugins
You must install one of the following NPC plugins for the SimpleCloud NPCs plugin to work:
| Plugin | Supported Versions | Status |
|---|
| Citizens | 1.19+ | ✅ Yes |
| FancyNpcs | 1.19.4+ | ✅ Yes |
| MythicMobs | 1.19+ | ✅ Yes |
| PlayerNPC | 1.17.1 - 1.20.1 | ✅ Yes |
Want to add support for another NPC plugin? Submit an issue on
GitHub! Actions
Available NPC actions and their options:
| Action | Option | Description |
|---|
open_inventory | inventory.name | Open server selection inventory |
run_command | command.name | Execute player command |
run_console_command | command.name | Execute console command |
connect_to_server | server.name | Send player to server |
transfer_to_server | server.ip, server.port | Send to external server |
quick_join | group.name, server.name.pattern, filter.player.count, filter.server.state | Random server join |
NPC Configuration
Example configuration:
version: "1.0"
id: bedwars
holograms:
- start-height: 2.073
lores:
- text: <group_name> - <property:server-software>
billboard: CENTER
alignment: CENTER
- text: waiting for <group_player_count:available> players
billboard: CENTER
alignment: CENTER
- text: "<server_count:ingame> Servers ingame"
actions:
- player-interaction: LEFT_CLICK
action: OPEN_INVENTORY
options:
inventory.name: bedwars
play.sound: block.chest.open
sound.pitch: 3
sound.volume: 2
- player-interaction: RIGHT_CLICK
action: TRANSFER_TO_SERVER
options:
server.ip: demo-server.com
server.port: 25565
options:
hologram.placeholder.group: lobby
send.message: <rainbow>Some cool text here
send.title: title
send.subtitle: some cool subtitle
Feedback Options
| Option | Description |
|---|
send.message | Chat message |
send.actionbar | Action bar message |
send.title | Title message |
send.subtitle | Subtitle message |
play.sound | Sound effect |
Inventory Configuration
Example inventory for server selection:
version: "1.0"
id: quickjoin.bedwars
title: <#ffffff>Bedwars
rows: 6
pagination:
listed-group-name: bedwars
server-name-pattern: <group_name>-<numerical_id>
state-items:
PREPARING: starting_pagination_item
STARTING: starting_pagination_item
AVAILABLE: available_pagination_item
INGAME: ingame_pagination_item
items:
- id: available_pagination_item
material: LIME_BANNER
display-name: <group_name> <numerical_id>
lores:
- "<gray>Players: <#38bdf8><online_players><dark_gray>/<#38bdf8><max_players>"
- ""
- "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
- "<gray>Template: <#a3a3a3><property:template-id>"
Commands
| Command | Description |
|---|
/scnpc apply <n> | Add SimpleCloud functions to an existing NPC |
/scnpc <id> interact <type> setAction <action> | Set click actions |
/scnpc <id> interact <type> setOption <key> <value> | Set click options |
/scnpc <id> setOption <key> <value> | Set global options |
/scnpc <id> setHologramGroup <groupName> | Set hologram group |
/scnpc createInventory <n> <groupName> | Create inventory config |
Permissions
| Permission | Description |
|---|
simplecloud.command.npc | Access to /scnpc |
