Add Horizon (Rust Java Edition server) as a server type

Open
#185 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
12/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
docker, java, rust, typescript

Research direction

Start with backend/bedrock.py, the existing non-Java server type, to see how a type gets its own container and settings. The open questions (image source, console input, arm64 Linux, web panel) need maintainer decisions before any code. Done means the acceptance criteria are met, starting with server type creation and the Start/Stop/console path.

Written by the indexing model from the issue text.

Description

enhancement

Summary

Add Horizon as a server type. Horizon is a Rust rewrite of Minecraft: Java Edition 26.3 (source, MIT). Its server is one native program, horizon-server, so it doesn't need a JVM to run. Vanilla 26.3 clients can join it.

The project's own benchmarks and hosting docs say that with up to 50 bot players it uses 3.8 to 4.8 times less memory than vanilla, Paper and Fabric with Lithium, and starts in about 8 seconds instead of 15 to 22. Its average tick is longer than Paper's at low player counts. Nobody outside the project has checked these numbers.

How it differs from the types we have

Every Java type we support runs on itzg/minecraft-server, and Bedrock runs on itzg/minecraft-bedrock-server (backend/bedrock.py). Horizon fits neither:

  • No Docker image. The project publishes Linux x86-64 and macOS arm64 builds as GitHub releases, plus an install script (packaging/server/install.sh) that checks each download's SHA-256. Isopod has to build or pull its own image. Releases are called "Nightly" and the server never updates itself; horizon-server update / rollback do that.
  • One-time preparation step. Before the first start, horizon-prepare --prepare --server-jar <server.jar> reads the vanilla 26.3 server jar, using the downloads.server.url from Mojang's version manifest. This step needs Java 25. After that, Java isn't used.
  • Config. Settings are in server.toml (TOML), not server.properties. It covers MOTD, port, max players, online mode, whitelist, view distance, game mode, difficulty, backups and its own web panel ([panel] bind). Changes apply at the next restart. The world, ops.json and the whitelist keep vanilla's names and formats, so a vanilla 26.3 world folder works as it is.
  • Commands and console. horizon-server run runs in the foreground with a console. It also has cmd, op/deop, whitelist add|remove, backup/restore and logs. The docs don't mention RCON, so we need to check how Isopod sends console commands.
  • Offline mode only. Horizon has no Microsoft sign-in yet, so Horizon clients can only join servers with online-mode=false. Vanilla players can join a Horizon server too.
  • No Java mods or plugins. Fabric, Forge and NeoForge mods and Bukkit/Spigot/Paper plugins don't run. Data packs work in part: functions, tags, predicates and item modifiers work, but recipes, loot tables, advancements and worldgen don't yet. Horizon's own mod formats (.hmod, .hnmod) are for the client. Mods, Plugins and Modpacks should be hidden for this type, the same way they are for Bedrock.
  • One version. Only Java Edition 26.3 is supported. Older worlds (1.8 to 26.2) are upgraded on load.

Acceptance Criteria

  • Horizon appears as a server type when creating a server, limited to the Minecraft version(s) it supports.
  • Isopod runs Horizon in a container, either one we build or one built from the official release with its SHA-256 checked. It does the preparation step itself the first time, and the user never has to install Java 25 or download server.jar.
  • Start, Stop and Restart work, and the console shows the log and accepts commands.
  • The players list, op/deop and the whitelist work, using vanilla's ops.json and whitelist files.
  • The server settings page reads and writes server.toml. Settings that don't apply are hidden, and the page says changes apply at the next restart.
  • New Horizon servers start in offline mode, and the UI explains why.
  • Mods, Plugins and Modpacks are hidden for Horizon servers. Data packs are labeled as partly supported.
  • Backups and resource usage work as they do for other types.
  • Updating to a newer Horizon build is done by Isopod (rebuilding the image or running horizon-server update). It doesn't happen without the user knowing.
  • Wiki: add a Horizon article covering what it is, offline mode, no Java mods or plugins, and data pack limits. Link it from the server type picker's help button.

Open questions

  • Should Isopod build its own image from the release binaries, or wait in case the project publishes one?
  • How does the console take commands: stdin on run, horizon-server cmd, or something else?
  • Isopod has its own dashboard, so should Horizon's web panel (horizon-server panel) stay off?
  • Only Linux x86-64 and macOS arm64 have builds. What do we do on arm64 Linux hosts, like a Raspberry Pi?

References

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
13h 12m
Merged PRs (30d)
57

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Isopod-Project/Isopod

All issues in Isopod-Project/Isopod

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.