Getting Started
Requirements
Server software, Java, database and Redis requirements to run sofyCore on a single Minecraft server or on a network.
Server software
sofyCore supports Spigot, Paper and Folia on every Minecraft version from 1.8.8 to 26.3. Install it on any server of your network, whatever its version. See Supported versions.
Java
You don't need any special Java version: use the one your Minecraft version already requires (for example Java 8 for 1.8.8 or Java 21 for 1.21). sofyCore works with all of them.
Database (required)
One persistence provider is required to start the core. It is selected with storage.persistence.provider:
| Provider | Use |
|---|---|
MONGODB (default) | Single server or network |
MYSQL | Single server or network |
MARIADB | Single server or network |
SQLITE | Single server only. A local file inside the plugin folder |
For MySQL and MariaDB, create the database and an account with CREATE, SELECT, INSERT, UPDATE and DELETE permissions before starting the server.
Redis (required)
Redis is required together with the database: it holds the shared cache, network presence and every cross-server message. All servers of a network must use the same Redis server and the same storage.redis.key-prefix.
If the initial connection to the database or Redis fails, sofyCore disables itself. Restore the service and restart the server or plugin.
Optional plugins
| Plugin | Integration |
|---|---|
| PlaceholderAPI | Exposes %sofycore_…% placeholders and expands external placeholders in chat, menus and the scoreboard |
| WorldGuard | Rank rules conditioned by region or region flags (WorldGuard 6 and 7) |
| LuckPerms / PermissionsEx | Includes importers to bring your ranks, permissions and prefixes over from LuckPerms 5.x and PermissionsEx. While they stay installed, sofyCore pauses its own permissions to avoid conflicts |
Proxy (optional)
BungeeCord and Waterfall work as they are. Velocity works while bungee-plugin-message-channel = true in velocity.toml (its default value). You don't need to install anything on the proxy.