Signs

Overview

The Signs plugin lets players click signs to connect to SimpleCloud group servers. Signs update automatically with server state, player counts, MiniMessage text, and optional animations.

Supported Software

Server Type	Plugin Support
Paper & Forks	Yes
Spigot	No

Quick Setup

Download the plugin from GitHub.
Place it in your server template’s plugins/ folder.
Make sure the simplecloud-api plugin is installed on the server.
Start the server once to generate the default layouts.
Look at a sign in-game and register it with /sign add <group>.

Commands

The command is available as /simplecloudsign, /simplecloudsigns, /scsigns, /scsign, /cloudsigns, /cloudsign, /signs, and /sign.

Command	Description
`/sign help`	Show command help
`/sign list [page] [group]`	List registered signs, optionally filtered by target
`/sign add <group>`	Register the sign you are looking at for a server group
`/sign remove`	Unregister the sign you are looking at
`/sign remove <group>`	Remove all signs for a registered target key

You must look at the sign block you want to add or remove. The command checks up to 8 blocks away.

Permissions

Permission	Description
`simplecloud.command.signs`	Use the base signs command
`simplecloud.command.signs.list`	List registered signs
`simplecloud.command.signs.add`	Register signs
`simplecloud.command.signs.remove`	Remove the targeted sign
`simplecloud.command.signs.remove.group`	Remove all signs for a target

Layouts

Layouts define what a sign displays for a matching server state. The plugin ships default layouts for STARTING, OFFLINE, MAINTENANCE, FULL, EMPTY, and ONLINE.

name: "online_default"
rule: "ONLINE"
priority: 9
serverName: "%group%-%numerical-id%"
frame-update-interval: 1250

frames:
  - lines:
      - "<color:#22c55e>⚡</color>"
      - "<group>-<numerical-id>"
      - "<player-count>/<max-players>"
      - "<color:#22c55e><b>ONLINE</b></color>"

Field	Description
`name`	Unique layout name
`rule`	Built-in rule name used to decide when the layout applies
`priority`	Higher priority layouts win when multiple layouts match
`serverName`	Name pattern used to resolve target servers
`frame-update-interval`	Animation interval in milliseconds
`frames`	One or more four-line sign frames

Placeholders

Use MiniMessage placeholder syntax inside layout lines.

Placeholder	Description
`<group>`	Group name for group servers
`<numerical-id>`	Numerical ID for group servers
`<type>`	Server type
`<host>`	Serverhost ID
`<ip>`	Server IP address
`<port>`	Server port
`<min-memory>`	Minimum memory in MB
`<max-memory>`	Maximum memory in MB
`<max-players>`	Maximum players
`<player-count>`	Current player count
`<state>`	Server state
`<player_name>`	Player name when a player-specific update runs
`<player_sender>`	Player’s current server when available

Server Name Patterns

The serverName field supports these replacement tokens:

Token	Description
`%group%`	Group name
`%numerical-id%`	Numerical ID

Introduction

Setup

Configuration

Plugins

Overview

Supported Software

Quick Setup

Commands

Permissions

Layouts

Placeholders

Server Name Patterns

​Overview

​Supported Software

​Quick Setup

​Commands

​Permissions

​Layouts

​Placeholders

​Server Name Patterns

Overview

Supported Software

Quick Setup

Commands

Permissions

Layouts

Placeholders

Server Name Patterns