Skip to main content

Repair a Paper YAML configuration error safely

A YAML error can prevent Paper or a plugin from starting after a configuration edit. The safe repair is usually a small correction near the first reported location. Deleting every configuration file can erase unrelated settings and make recovery harder. Preserve the broken file before changing it, even when the error appears obvious.

Identify the actual file

Open the console or latest log and find the first parsing exception from startup. Record the filename, line and column if shown. A later plugin failure may be a consequence of an earlier configuration error, so begin at the earliest relevant message. Confirm whether the file belongs to Paper itself or to a plugin; their schemas are not interchangeable.

Download the current file and your last known working copy. If the server is repeatedly attempting to start, stop it through the panel while you investigate. Use a text editor that displays line numbers and whitespace. Do not upload a private configuration to a public validator because it may contain database details, webhook URLs or other credentials.

Check structure before changing values

YAML uses indentation to express nesting. Use spaces, not tab characters, and align neighbouring keys at the same level. A line reported as invalid can be where the parser finally noticed a problem that began above it. Inspect the preceding section, especially an unfinished quote, missing colon or list entry with the wrong indentation.

Keep scalar values in the format documented for that option. A duration, integer, Boolean and list are different types. Quoting everything can turn a number or Boolean into text and produce another error even if the YAML now parses. Conversely, a value containing special punctuation may need quoting. Follow the software's example rather than applying one rule to every line.

Do not add duplicate copies of a section to make a new setting fit. Merge the single intended change into the existing section. Leave Paper's internal _version marker unchanged. For Paper world configuration, consult the paths and schema matching the exact installed build; current 26.x examples can differ from the files generated on 1.21.11.

Validate the smallest repair

Compare your edit with the downloaded file and confirm that only the intended lines changed. Save, start the server and read the console from the beginning. If a new error appears, capture it and stop again rather than making a series of unrecorded guesses. Successful parsing does not prove that the setting has the desired effect, so test its behaviour separately.

If you cannot identify the syntax problem, restore the known working copy of that configuration file and restart. Keep the broken version under a different local filename for support. Avoid replacing the whole world, plugin directory or server installation to repair a text-format error.

Prevent a repeat

Make future changes one section at a time and retain a small change note with the build and file path. Use generated defaults from the same release as a structural reference. If no working copy exists, ask support to help compare the damaged file with release-appropriate defaults without discarding your custom settings.

Reference

Paper configuration files and version markers. Paper world configuration schema.