Osmium

Download

Osmium is a server modding framework for Rust. Import the egg into your panel, create a server, and Osmium installs itself and updates itself when Rust does. It is in early access now, with the full launch soon.

Get Osmium

One egg for each panel. Both carry the same framework; the panel only changes how it is imported. The egg installs Osmium from our release server, on the public channel, and keeps it updated.

Install

  1. Import the egg into your panel (Pelican or Pterodactyl) as a new egg. It is a new egg: import it even if you have an older Osmium egg.
  2. Create a server from it. The egg installs Rust through SteamCMD and then Osmium from our release server. To move an existing Oxide or Carbon server instead, change its egg to this one, set its startup command to the egg’s default (Pterodactyl keeps a server’s old one), and reinstall: Osmium takes over the other framework’s plugins, configs, data and permissions where they are.
  3. Start the server. On the first start Osmium shows the Terms of Use and asks you to accept them once: set the server’s “Accept Osmium Terms” option to 1, or to the version you accepted (2026-10-18). That one step also activates the server.
  4. From then on the server updates itself. Rust updates are followed by an Osmium release made for the new build, and your server moves to it according to the update policy you pick.

Osmium credits itself on your server, and changes nothing in the game to do it: one line “Powered by Osmium - osmiummod.com” under your description in the server browser, the tag osmium in the server’s tags, and one small grey chat line, “This server runs Osmium - osmiummod.com”, for each player once per wipe. It is on by default. To switch it off, set the server’s “Osmium credit” option to 0 and restart, or run osmium.module advert off on the console; each part can also be switched on its own in osmium/config/modules/advert.json.

Upgrading from Osmium 0.3

A server that already runs Osmium 0.3 must keep “Accept Osmium Terms” at 1 until Osmium 0.4 is installed on it. Its old start script refuses a date, so setting the option to 2026-10-18 before the upgrade stops the server from starting. Once 0.4 is installed, either value works.

What you get

Plugins as they are
Oxide and Carbon plugins load unmodified; where they come out equal we say so. Measured compatibility
Ready at start
Every hook your plugins expect is in place before the first plugin loads.
Self updating
The server follows a release channel. When Rust updates, it moves to the release made for the new build, or holds until one exists, as its settings say.
Takeover
A server that ran Oxide or Carbon is taken over rather than refused: their files move aside, their plugins, configs and data are used in place, and a rollback puts them back.

Requirements

  • Linux, x86_64.
  • glibc 2.34 or newer (the game image the egg ships uses one that is new enough).
  • Rust on the public branch. Osmium releases are made for it, and a server on another branch does not start.
  • A Pelican or Pterodactyl panel with the Rust egg's image available.

Licence and your data

Osmium is proprietary software. The download is the compiled framework and its egg; it carries no source code.

Running Osmium means you accept the Terms of Use. On first use your acceptance is registered once, together with the server's identity, and that is what activates the licence. After that Osmium needs no further contact to keep running; if the server cannot reach us at first use, it runs and waits for you to activate within a grace window.

Every category of data collection is off by default. Error reports, performance detail and plugin and configuration upload are each turned on only if you choose, and you can turn any of them off at any time. Osmium never collects player names, SteamIDs, player IP addresses or chat.