The Map Metadata Page
The Map Metadata Editor Page of the PBS Editor.
Overview
The Map Metadata page is the dedicated editor within the PBS Editor for viewing and modifying all Map Metadata PBS data in your project. It provides a structured interface to inspect and edit every Map Metadata entry without needing to work directly with raw PBS files.
All default parameters defined by Essentials are presented in a clear and consistent layout, making it easy to understand and manage Map Metadata data at a glance. In addition, any fields introduced through plugins or custom extensions are automatically detected and displayed when present.
These extra properties are grouped under the Other Fields section, allowing the editor to remain clean and organized while still supporting extended functionality.
The screenshots below illustrate the general layout and structure of the Map Metadata editor. They serve as a visual guide to help you quickly locate sections and understand how information is organized within the interface.
Detailed explanations of individual parameters are provided in the sections that follow. For deeper technical insight or engine-level behavior, refer to the official documentation: Defining a Map's Metadata on the wiki.
Wiki
Settings
Import Map Metadata
To Import one or more Map Metadata into the Editor, your data must be provided in a TSV (Tab-Separated Values) file.
The easiest way to create this format is by using Google Sheets, which allows you to quickly orignize your data and export it directly as a TSV file.
For reference, you can use the following example as a template for structuring your data correctly: TSV Berry Plants Example
Required Fields
Each Map Metadata entry must include the following required paramters:
- ID
- name
- mapPosition
If any of these fields are missing, the editor will skip the entry and report which required values are not present-helping you quickly identify and correct issues in your file.
File Selection
This dropdown allows you to choose between all available Map Metadata PBS files detected in your project.
The primary file is typically named map_metadata.txt, but the editor also supports additional files following the format map_metadata_xxx.txt.
The underscore (_) is required for these extra files to be recognized. Any text can follow it (e.g. map_metadata_custom.txt), but files without this naming pattern will not be detected as Map Metadata PBS files.
If only a single file is available, the dropdown will be automatically disabled, and that file will be selected by default.
Map Metadata Selection
This dropdown lists all available Map Metadata entries for the currently selected file, identified by their ID.
In the PBS file, these IDs are defined using the format [xxx]. For improved readability, the editor display them without brackets but with the matching Name Field value in the interface.
Despite this visual simplification, the brackets are still required in the actual PBS structure. When saving, the editor will automatically restore the correct [xxx] format, even though it is not shown within the editor itself.
ID
The ID servers as the internal identifier used by the engine to reference a Map Metadata. Each Map Metadata must have a unique ID to function correctly and should match the ID of an existing Game Map.
The ID is formatted as a 3-digit number (e.g. 002, 011). To help prevent errors, the editor will automatically pad the value with leading zeroes as you type.
Within the PBS file, the ID defines the start of a new Map Metadata entry and must always appear first in each block. This structure is handled automatically by the editor when saving, so no manual formatting is required.