When you start Scribe for the first time, it generates several files inside the plugins/Scribe/ folder. Understanding what each file does is crucial for effectively managing the plugin.
File Structure
plugins/Scribe/
├── config.yml # Core settings and moderation rules
├── formats.yml # Visual layout of chat and system messages
├── commands.yml # Command toggles, aliases, and permissions
└── messages/
└── en.yml # Localization (Plugin feedback messages)
config.yml
This is the brain of the plugin. Here you configure:
- Global settings (language, debug mode, time formats).
- Brand colors (defining what
<primary>and<error>look like). - Chat channels (Local chat radius vs Global chat).
- Moderation (Caps filter, spam cooldowns, word blacklists).
- Mention settings (Sounds, actionbars, titles).
formats.yml
This is the paintbrush of the plugin. Here you configure:
- The exact layout of chat messages (e.g.,
[Admin] Notch » Hello!). - Formats for different LuckPerms groups.
- Private message formats (Sent, Received, and Spy).
- Roleplay formats for
/me,/try, etc. - Server broadcasts (Join, Quit, Death).
commands.yml
This file allows you to heavily customize how players interact with Scribe:
- You can disable any command entirely (e.g., if you don’t want roleplay commands, set them to
enabled: false). - You can change aliases (e.g., changing
/msgto/whisper). - You can change the permission node required to execute the command.
messages/en.yml
All messages sent by the plugin to the player (e.g., “You do not have permission”, “Player not found”, “Chat is muted”) are stored here. You can translate Scribe into any language.