Skip to content

Getting Started

Installation

Install sofyCore on a Spigot, Paper or Folia server, connect the database and Redis, and verify that the core started correctly.

  1. Get the plugin JAR

    Download sofyCore-<version>.jar after your purchase. The same file works on all your servers, whatever their version. The API JAR is only for developers and is not installed on the server.

  2. Prepare the database and Redis

    Have one database (MongoDB, MySQL, MariaDB or SQLite) and a Redis server ready. For MySQL or MariaDB, create the database and a user with CREATE, SELECT, INSERT, UPDATE and DELETE permissions.

  3. Copy the JAR and start once

    Put the JAR in the plugins/ folder and start the server. sofyCore creates plugins/sofyCore/ with config.yml, the lang/ folder and the module files.

  4. Add your license

    Copy your license file into plugins/sofyCore/license/. If you don't have it yet, see Get your license.

  5. Configure storage

    Edit the storage section of config.yml (provider, connection and Redis). Connection changes require a server restart. See Storage.

  6. Restart and check the console

    On a new installation sofyCore generates a unique server name and prints it in English, for example Generated server name: server-a4c9d3. If the database or Redis cannot be reached, the core disables itself and logs the reason.

Files created

  • plugins/
  • sofyCore/
  • config.yml# global settings, storage and module switches
  • license/# your license file
  • lang/# en.yml, es.yml and per-module folders
  • announcements.yml
  • chat.yml
  • private-messages.yml
  • ranks.yml
  • staff.yml
  • essentials.yml
  • vippoints.yml
  • maintenance.yml
  • menus.yml
  • scoreboard.yml
  • tags.yml# only used as an explicit import source
  • backups/# copies made before automatic config updates

Windows console encoding

If the console shows text such as m├│dulo, the server console is not using UTF-8. A Windows launcher can set it explicitly:

start.cmdBash
@echo off
chcp 65001 >nul
java -Dfile.encoding=UTF-8 -Dstdout.encoding=UTF-8 -Dstderr.encoding=UTF-8 -Xms512M -Xmx2G -jar spigot.jar nogui
pause