Guild
Official compatibility
| Element | Reference |
|---|---|
TypeWriter | Required. Use the official TypeWriter release supported by the extension release. |
| Related extensions | Install the related extensions listed on this page before using entries that depend on them. |
The Guild Extension lets players form persistent guilds: create a guild, invite members, manage roles, and browse everything through a GUI menu. Guild data is stored in an artifact and synchronised across servers.
Features
- Guild Management — Create, disband, join, and leave guilds.
- Roles & Hierarchy — Promote, demote, and transfer guild ownership.
- Invitations — Invite players and let them accept from the menu.
- Persistent Storage — Guild data is kept in a dedicated artifact and shared across servers via Redis.
Commands
| Command | Description |
|---|---|
/guild help | Show the command help. |
/guild create <name> | Create a new guild. |
/guild invite <player> | Invite a player to your guild. |
/guild join <guild> | Join a guild you were invited to. |
/guild leave | Leave your current guild. |
/guild kick <player> | Remove a member from the guild. |
/guild promote <player> | Promote a member. |
/guild demote <player> | Demote a member. |
/guild transfer <player> | Transfer guild ownership. |
/guild info | Show information about your guild. |
/guild disband | Disband the guild. |
Entries
- Actions — Guild Menu: opens the guild interface.
- Artifacts — Artifact for storing guild data: persistent guild state.
User guide
- 1. Add the storage artifact — Create the guild_artifact entry so guild data can be persisted. → guild_artifact
- 2. Open the menu — Trigger the guild_menu action from a command, NPC, or item. → guild_menu
Permissions
| Permission | Description |
|---|---|
guild.use | Use the guild system. |
guild.admin | Administrate guilds. |
Dependencies
| Extension | Required | Usage |
|---|---|---|
| GUI Extension | Required | Renders the guild menu (layoutPool, mainLayoutId). |
| MySQL Extension | Required | Redis-backed cross-server guild synchronisation. |
Troubleshooting
The extension is not visible
Check that the installed release matches the supported TypeWriter release and that the related extensions listed in the compatibility section are present.
An entry is missing
In the Typewriter Web panel, use the Search bar or the + button to find or create the entry with its exact identifier. Entry IDs and field names are case-sensitive; do not translate them.
The entry saves but nothing happens
Check that the entry is connected to the trigger, command, objective, event, or menu interaction required by its type. Test with optional permissions and criteria removed, then add them back one at a time.
An integration does not work
Verify the dependency and version shown in the extension card, then check the server log for the first error. Do not replace a missing dependency with a similarly named plugin unless the extension source explicitly supports it.