Skip to content
Oasis
Select theme
  • Auto
  • Dark
  • Light
Download

Install Oasis

This page takes you from an empty plugins folder to a server that logs. It takes a few minutes.

1. What you need

Section titled “1. What you need”
  • Paper for Minecraft 1.21.11, 26.1, 26.2 or 26.3. One Oasis jar covers all of them.
  • Java 25 or newer. On an older Java, Oasis tells you the version it needs and does not start.
  • FastAsyncWorldEdit, if you want WorldEdit changes logged. Oasis logs FAWE, not plain WorldEdit.

You don’t need a database. Oasis brings its own and runs it inside your server.

2. Install the jar

Section titled “2. Install the jar”
  1. Stop the server.
  2. Download Oasis from Downloads and put the jar in your server’s plugins folder. If you use FAWE, keep the FAWE jar there too.
  3. Start the server. Oasis creates plugins/Oasis/config.yml and starts logging straight away. You don’t have to change anything in that file.
  4. Give your staff the permissions they need. Every Oasis permission starts out as operator only. Commands lists each one.

Oasis keeps its history in plugins/Oasis/store. If you move your server, take that folder with it, along with plugins/Oasis/client-id.

Section titled “3. Recommended setup for FAWE”

Skip this section if you don’t use FAWE. If you do, the console can show two warnings from Oasis at the first start:

FAWE's max-memory-percent is 95. A large FAWE edit can then fill the heap and stall the server in full garbage collections. Run /oasis fawe tune to set it to 75.
FAWE hands one queue to every edit on a thread, so Oasis can log a chunk under another player's name (FastAsyncWorldEdit#3668). Run /oasis fawe patch to fix it.

We recommend both fixes. You need the oasis.fawe permission, and you can run each command in game or from the console. Each command shows a preview first, which changes nothing. To confirm, click the link in chat, or type the confirm command in the console within two minutes.

Lower FAWE’s memory limit

Section titled “Lower FAWE’s memory limit”

FAWE ships with max-memory-percent at 95. At that level, a big edit can fill almost all of your server’s memory, and TPS falls while Java cleans up.

  1. Run /oasis fawe tune. Oasis names a safer value for your server: 75 if you use Aikar’s flags, 85 if you use Java’s defaults.
  2. Click [tune FAWE], or type /oasis fawe tune confirm in the console. Oasis writes the value to FAWE’s config and applies it right away.

Turn on the FAWE queue patch

Section titled “Turn on the FAWE queue patch”

FAWE has a bug. When two WorldEdit jobs run at the same time, Oasis can log part of one player’s edit under the other player’s name. A lookup can then blame the wrong person, and a rollback can miss part of an edit.

The patch makes the one-line fix from FAWE pull request #3669, in memory while your server runs. Oasis never changes the FAWE jar.

  1. Run /oasis fawe patch. Oasis tells you what the bug does and what the patch changes.
  2. Click [patch FAWE], or type /oasis fawe patch confirm in the console.

Oasis remembers your choice and patches FAWE again at each start, also after you update FAWE. To turn the patch off, run /oasis fawe unpatch.

4. Check that it works

Section titled “4. Check that it works”

Run /oasis status and look for these lines:

  • Database: Packs Embedded. Oasis has its store open.
  • Logging: up to date. Oasis has saved every edit so far.
  • With FAWE, FAWE: queue patch on · tuned. If the line says run /oasis fawe patch or run /oasis fawe tune, go back to step 3.

Then place a block, run /inspect, and left-click the block. Oasis shows its history, with your edit in it. Run /inspect again to turn the inspector off.

That’s it. Oasis is logging.

Updating Oasis

Section titled “Updating Oasis”

Oasis tells you in the console and in /oasis status when a newer build is out. Put the new jar in place of the old one and restart. Your history stays. Updating covers Packs Server, mismatched versions, and going back to an older version.

Where to go next

Section titled “Where to go next”