Uninstalling

By the end of this page you will have removed as much or as little of Osmium as you meant to, without losing a world by accident.

Remove the binary#

Installed with the install script on Linux or macOS:

$ rm ~/.local/bin/osmium

Installed with the install script on Windows — delete the folder, then remove it from your user PATH under Settings → System → About → Advanced system settings → Environment Variables:

PS> Remove-Item -Recurse "$env:LOCALAPPDATA\Programs\osmium"

If you set OSMIUM_INSTALL_DIR when installing, remove it from there instead.

Installed with the Go toolchain or built from source:

$ rm "$(go env GOPATH)/bin/osmium"

Installed from a release archive — delete the binary wherever you put it, for example /usr/local/bin/osmium.

If you installed shell completion, remove the script too. osmium completion install printed the path it wrote to; it is under your shell's user completion directory.

What removing the binary does to your servers#

Nothing. A server is an ordinary folder with a jar, a world, a run script and the two Osmium files. Removing Osmium leaves every one of them in place, and a server that was running keeps running until it is stopped, because it is held by its own detached supervisor process rather than by Osmium.

Stop your servers before uninstalling if you want them down — without the binary there is no osmium stop.

Remove the settings and the registry#

Osmium's own state lives in one directory:

It holds config.json — your theme, your default server folder, your default memory and your saved Manage Servers layout — and the registry of which servers Osmium knows about.

Deleting this directory does not delete any server. It deletes Osmium's list of them. Each server's own osmium.json and osmium.lock are inside the server folder, so a server is not lost by this: run osmium inside its folder, or osmium install --server against it, and it is registered again on the spot.

The one exception is servers you created with the default location. Those live in a servers/ subdirectory inside this same config directory, so deleting the directory wholesale deletes those servers, worlds included. Move them out first:

$ mv ~/.config/osmium/servers/* ~/minecraft/

Remove the download cache#

The cache is separate, and is safe to delete at any time:

Nothing in it is needed to run a server; emptying it only means the next install downloads again. Osmium can do it for you:

$ osmium cache          # where it is, and how much room it takes
$ osmium cache clean    # empty it

Remove one server#

To delete a single server rather than uninstalling Osmium:

$ osmium destroy -s old-test

It asks you to type the server's name, then deletes the folder and everything in it, world included. It also offers to keep osmium.json beside the folder first, which is what lets you build the same server again later with osmium create --from.