StaffCore Documentation
1) Installation
- Stop your server.
- Place StaffCore.jar inside plugins/.
- Start the server.
- Wait until StaffCore generates its files.
- Configure files in plugins/StaffCore/.
- Use /staff reload after changes.
2) File Structure
- plugins/StaffCore/config.yml -> Main behavior settings.
- plugins/StaffCore/ui.yml -> Visual templates and UI text blocks.
- plugins/StaffCore/lang/*.yml -> Translation files (EN/ES/FR/PT).
- plugins/StaffCore/wiki/ -> Generated wiki/help files for server owners.
- plugins/StaffCore/*.yml data files -> Reports, punishments, logs, notes, etc.
3) Recommended Setup
- Use LuckPerms for permissions management.
- Create separate staff ranks (Helper, Mod, Admin).
- Only grant high-impact permissions to trusted ranks.
- Review moderation templates before going live.
4) Core Commands
Code (Text):
/staff
/staff on
/staff off
/staff menu
/staff reload
/staff help
/vanish
/freeze <player>
/report <player> <reason>
/reports
/helpop <message>
/warn <player> <reason>
/mute <player> <duration|perm> <reason>
/unmute <player>
/sckick <player> <reason>
/scban <player> <reason>
/sctempban <player> <duration> <reason>
/scunban <player>
/history <player>
/stafflogs
/stafflang <en|es|fr|pt>
/xrayalerts
5) Main Modules
Staff Mode + Vanish
- Quick moderation access.
- Vanish tools for silent observation.
- Protection settings to reduce abuse.
Freeze
- Hard movement lock.
- Command-escape prevention.
- Reconnect freeze persistence.
- Visual freeze notifications.
Reports
- Player report creation.
- Staff review flow with accept/reject.
- Clean tracking and moderation workflow.
Punishments
- Warn, mute, kick, ban, tempban, unban.
- Template-driven messages.
- History and logging integration.
X-Ray Alerts
- Heuristic alert logic (ratio/burst/cooldown).
- Anti-false-positive controls.
- Runtime toggles for staff.
6) Customization
config.yml
- Feature toggles.
- Cooldowns and limits.
- Security and anti-abuse options.
- Module behavior control.
ui.yml
- Staff-facing visual templates.
- HelpOp, HUD, and tool naming styles.
- Layout and compact/extended text presentation.
lang/*.yml
- All translatable messages.
- Per-language message control.
- Easy localization edits.
7) Permissions (Best Practice)
- Grant only what each rank needs.
- Keep override/force permissions restricted.
- Test every rank before production release.
- Audit permission groups after updates.
8) Performance Notes
- Use async/batch save options when available.
- Avoid unnecessary debug spam on production.
- Review log retention limits to prevent oversized files.
- Use X-Ray settings appropriate for your server size.
9) Troubleshooting
If you report an issue, include:
- Server software and exact version.
- StaffCore version.
- Full console error log.
- Steps to reproduce.
- Relevant config section.
Quick checks:
- Did you reload after editing config files?
- Are permissions correctly assigned?
- Are language files complete and not manually broken?
- Are conflicting moderation plugins installed?
10) Update Workflow
- Backup current plugin folder and data files.
- Upload new StaffCore jar.
- Start server and check startup log.
- Review new config keys.
- Test core commands with staff ranks.
StaffCore Documentation
Clean moderation. Strong control. Production-ready workflow.