Installation

Installation

Requirements

Requirement	Supported
Server software	Spigot, Paper, Purpur, Pufferfish, Airplane, Folia, Leaves, Gale, or another Bukkit-compatible fork
Minecraft	1.8.8 – 1.21.x+
Java	Whatever your Minecraft version needs (Java 8, 11, 16, 17, 21, 25+). The universal JAR is Java 8 bytecode.

Steps

1. Download OptimizeServer.jar from one of these:
   • Modrinth
   • SpigotMC
   • GitHub Releases
2. (Optional) Check the download against the .sha256 / .sha512 files attached to the GitHub Release:

   sha256sum OptimizeServer.jar

3. Copy the JAR into plugins/.
4. Restart the server. Avoid /reload and plugin managers.
5. Check that it loaded:

   /os version
   /os status
   

Generated Files

plugins/OptimizeServer/
├── config.yml      # Main configuration (see the Configuration page)
└── reports/        # Local diagnostic reports from /os report generate

Automatic Spark & Chunky Installation

On startup, OptimizeServer checks whether the optional integrations are present:

Plugin	Purpose	Source
Spark	CPU/memory profiling for /os profile and /os health	SpigotMC (via Spiget)
Chunky	Chunk pre-generation for /os chunks start	Modrinth (falls back to Spiget)

If one of them is missing, OptimizeServer:

1. downloads it asynchronously (startup is never blocked),
2. checks its SHA-512 checksum (when the source provides one) and makes sure it is a valid JAR,
3. installs it into plugins/,
4. loads it on the main server thread.

Spark that comes bundled with Paper 1.21+ is detected, so a second copy is not installed.

Turning Auto-Install Off

integrations:
  auto-install:
    enabled: false        # turn off auto-install entirely
  spark:
    auto-install: false   # or turn it off for just one plugin
  chunky:
    auto-install: false

Chunky never starts generating chunks on its own. Pre-generation only runs when an admin uses /os chunks start.

Updating

Replace OptimizeServer.jar with the new version and restart. Your config.yml is migrated to the new schema automatically, and your existing values are kept.

Uninstalling

Delete OptimizeServer.jar and, if you want, the plugins/OptimizeServer/ folder. OptimizeServer never changes world data or server configuration, so there is nothing else to undo.