Skip to content

Getting Started

Introduction

What sofyCore is, which problems it solves and how its modules fit together on a single server or a whole network.

sofyCore is a modular core for Minecraft servers and networks. Instead of combining a ranks plugin, a moderation plugin, a staff plugin, a chat plugin and a shop that do not know about each other, sofyCore provides all of them in a single plugin that shares the same storage, the same permission hierarchy and the same configuration style.

What problem it solves

Running a network usually means keeping a dozen plugins compatible with each other and with every Minecraft version. Each one stores data its own way, has its own idea of "staff", and together they end up dragging your TPS down. sofyCore was designed around three ideas:

  1. Fast and lightweight. Ranks, sanctions, VIP points, tags and profiles are stored in your database (MongoDB, MySQL, MariaDB or SQLite), and sofyCore relies on Redis to make every lookup much lighter: your players get instant responses and your TPS stay healthy.
  2. Network first. Ranks, sanctions, private messages, staff chat, vanish, freeze, boss bars and maintenance are synchronized in real time across all your servers.
  3. Safe by default. A strict hierarchy (console > owner > admin > staff > user) is checked again when every change is saved. Being OP or having * never bypasses rank administration.

Modules

Each feature is a module with its own switch in config.yml (modules.<name>.enabled), its own configuration file when it needs one, and its own reload command. A disabled module registers no listeners, commands or tasks.

ModuleWhat it provides
ranksRanks, grants, permissions, conditional rules, /access and /color
moderationBans, IP bans, mutes, warnings, kicks, blacklist, history and reports
staffFreeze, vanish, staff mode, /follow, server manager and staff list
chatChat format, mute, slow mode, filters, staff/admin channels and mentions
private-messages/msg, /reply and ignore lists, also across servers
announcementsLocal rotating announcements and network announcements (/sout)
bossbarRotating, animated network boss bars
scoreboardSidebar scoreboard with animated titles and placeholders
nametagsRank above the head and TAB sorted by rank
menusBuilt-in inventory menus and custom menus in menus.yml
vippointsGlobal VIP points and a rank shop
maintenanceNetwork maintenance that gives purchased ranks back the time spent in maintenance
essentialsLocal admin commands such as /gamemode, /fly, /tp, /invsee

Tags, playtime and user preferences are general services that are always available.

Single server or network

sofyCore works on a single server and on networks behind BungeeCord, Waterfall or Velocity. For a network, every server must share the same database (MongoDB, MySQL or MariaDB), the same Redis server and the same Redis key prefix. SQLite keeps data in a local file and is meant for a single server.