Skip to main content

Getting Started

Use this checklist to prepare any server for the NekoSoft plugin suite.

Requirements​

  • Minecraft server: PaperMC or compatible fork. Specific minimum versions are called out in each plugin guide.
  • Java runtime: AdoptOpenJDK/Temurin 17 or 21. Keep the runtime patched on every build host and production node.
  • Hardware: SSD-backed storage and at least 4 dedicated cores for video streaming or cheat detection workloads.
  • Permissions: Console access plus SFTP/RCON to push binaries and collect diagnostics.

Install workflow​

  1. Backup first – snapshot the world directory and configs before introducing a new plugin.
  2. Download releases – grab the latest .jar from the NekoSoft portal or GitHub Releases.
  3. Stage configs – copy the plugin into plugins/ (or mods/ for Fabric builds) and run the server once to generate defaults.
  4. Tune locally – edit YAML/JSON assets with the recommended presets from each plugin section.
  5. Roll out progressively – deploy to staging, observe TPS/CPU for a full play session, then promote to production.

Operational best practices​

  • Keep a plugins/nekosoft/ folder to store shared assets (cinematics, ML signatures, etc.).
  • Version-control configuration files alongside infrastructure-as-code templates.
  • Automate plugin restarts with your orchestration layer (systemd, Pufferfish Manager, Kubernetes operators, etc.).
  • Export metrics to Prometheus/Grafana to catch regressions quickly.

Once these foundations are in place, continue with the plugin-specific tutorials below.