← Back to Home
ResourceWorldResetter Wiki

Everything you need to install, configure, and operate RWR

This page is the local documentation hub for the plugin. It covers setup, command usage, config keys, reset lifecycle behavior, region resets, recovery, and the practical limits of the current v4 release.

Plugin Version
4.0.1
Command Root
/rwr
Target
Spigot / Paper 1.21+
Recovery
Phase-aware resume
Important: the current release is designed around one configured resource world. Select the world through /rwr gui, then manage schedules and resets from there.

Getting Started

Install the plugin, let it generate its config, then use the GUI or commands to define the resource world and schedule.

Quick Setup
1

Install prerequisites

Use Java 21+ and a compatible Spigot/Paper 1.21+ server. Multiverse-Core is a soft dependency for world handling.

2

Drop the JAR in plugins

Place the release jar in your plugins/ folder and start the server once to generate config.yml.

3

Select the resource world

Run /rwr gui and choose the world you want the plugin to reset.

4

Confirm the schedule

Set the reset frequency, warning time, and day/hour settings, then verify everything with /rwr status and /rwr next.

What the Plugin Does

RWR tracks a reset from start to finish using a phase model. That means you can see where a reset is, recover after interruption, and review the last failed phase when something goes wrong.

Players can use /rwr tp to open the teleport GUI and /rwr back to return to a recorded previous location. Admins keep the reset pipeline under one command tree instead of scattered aliases.

If the server stops mid-reset, the plugin stores recovery state so it can resume from the next safe phase instead of starting over blindly.

Command Reference

All functionality hangs off /rwr. Permissions are enforced per subcommand, with the admin permission covering the management actions.

Command Description Permission
/rwr gui Open the admin configuration GUI. resourceworldresetter.admin
/rwr reload Reload configuration from disk after manual edits. resourceworldresetter.admin
/rwr reset now Force an immediate reset of the configured resource world. resourceworldresetter.admin
/rwr resume Resume an incomplete reset detected on disk. resourceworldresetter.admin
/rwr resume cancel Cancel auto-resume and clear incomplete reset state. resourceworldresetter.admin
/rwr status Show the current phase, next reset, and last failure details. resourceworldresetter.admin
/rwr next Show the next scheduled reset timestamp and countdown. resourceworldresetter.admin
/rwr region ... Manage region-based resets with list, add, remove, enable, disable, and addhere flows. resourceworldresetter.admin
/rwr tp Open the player teleport GUI for available worlds. resourceworldresetter.tp
/rwr back Teleport back to the last stored location. resourceworldresetter.back
/rwr help Show in-game help and usage examples. all players

Configuration

The config is versioned. Keep the file structure intact and let the plugin migrate older schema versions where possible.

# Config schema version - do not edit
configVersion: 4

# World name to reset. Select this in /rwr gui on first install
worldName: "Resources"

schedule:
  mode: "daily" # daily | weekly | monthly
  time:
    hour: 3
  warningMinutes: 5
  day: 1

regions:
  enabled: false
  immediateRegenerationOnAdd: true
  list: []
Key Fields

configVersion should stay at the shipped version so migration logic can detect the schema correctly.

worldName is the resource world selected by the plugin. Leave it empty on a first install and set it from the GUI.

schedule.mode supports daily, weekly, and monthly. The hour is 24-hour time.

regions.enabled switches the plugin into region-based reset mode. When enabled, the region list determines which chunks or named regions are reset.

immediateRegenerationOnAdd regenerates a region as soon as it is added, which is useful when you want to seed fresh terrain without waiting for the next scheduled cycle.

Reset Phases

The reset pipeline is explicit. That makes recovery, logging, and status reporting deterministic.

IDLEWaiting
Nothing is currently happening. This is the normal resting state between scheduled resets.
PRECHECKPreparation
The plugin prepares the reset run and confirms the next action path before player movement begins.
TELEPORTEvacuation
Players are moved out of the resource world before the world is unloaded or deleted.
UNLOADWorld shutdown
The target world is unloaded from the server so the underlying files can be replaced safely.
DELETERemove old data
The old world data is removed as part of the reset workflow.
RECREATEFresh world
A clean world is created again using the configured world and generator path.
VERIFYSanity check
The plugin confirms the reset completed correctly before it marks the task complete.
COMPLETEFinished
The reset cycle is finished and the next schedule can be computed.
FAILEDRecovery state
The reset stopped before completion. Check /rwr status and use /rwr resume or /rwr resume cancel.

Region Resets

Region mode lets you target a defined set of areas instead of wiping the entire world.

Typical Workflow

Enable region mode, add the regions you want to manage, then confirm the list with /rwr region list.

You can add regions manually or use addhere from your current location, depending on how your build is configured.

If immediateRegenerationOnAdd is enabled, a newly added region is regenerated right away.

Good Practices

Keep region names and coordinates consistent. The plugin stores regions in config and reuses them on reload.

Use /rwr status before any destructive action so you know whether a reset is already in progress.

If you are upgrading from an earlier release, review the migration notes before enabling region mode on a live server.

Permissions

The plugin separates admin actions from player-facing utility commands.

Permission Scope Default
resourceworldresetter.admin Full access to admin commands, GUI actions, schedule management, and reset control. op
resourceworldresetter.tp Allows access to the teleport GUI for player travel. true
resourceworldresetter.back Allows teleporting back to the previous recorded location. true

Troubleshooting

If something behaves unexpectedly, check the current phase and the generated messages first. The plugin is designed to tell you where it stopped.

Common Issues

No world configured: open /rwr gui and select a resource world before scheduling resets.

Reset interrupted: run /rwr status to see the failed phase, then resume or cancel recovery.

Teleport failed: make sure the player has permission and the target world exists at the time of the command.

Regions not changing: confirm region mode is enabled and the region list contains the coordinates or entries you expect.

Recovery Notes

When a reset fails, the plugin stores the phase that failed plus the next safe phase for recovery.

Use /rwr resume to continue the incomplete reset, or /rwr resume cancel to intentionally discard it.

If you are unsure whether a reset is active, /rwr status is the safest first check before taking any manual action.

FAQ

Can I use this without editing YAML?
Yes. The intended workflow is to use /rwr gui for setup and routine maintenance. The config file is there for advanced editing and migration handling.
Does it require a full restart for each reset?
No. The reset flow is designed to run inside the live server lifecycle and resume after interruptions when needed.
What happens if the server stops mid-reset?
The plugin records incomplete state, then resumes from the next safe phase after startup unless you cancel recovery.
Is multi-world reset support included?
Not in the current local documentation scope. Treat this release as a single selected resource world with optional region-based resets.