Pages Configuration
SettingsPlus allows you to create multiple pages for your settings menus. Each page must be stored inside the Pages
folder and follow a specific layout. This layout ensures that the plugin can properly display and navigate between the pages.
Page Layout Structure
Below is the required structure for a settings page:
Explanation of Fields
1. Inventory
Defines the main configuration of the inventory interface:
size
: The number of slots in the inventory. Valid values are multiples of 9 (e.g., 9, 18, 27, 54).Example:
54
name
: The name of the inventory, visible at the top. You can use placeholders like%page%
to indicate the current page.Example:
"Your Settings - Page %page%"
Page-Count
: The total number of pages this inventory contains.Example:
1
2. Filler Slots
filler
: Define the item used to fill empty slots in the inventory.material
: The item material. Example:BLACK_STAINED_GLASS_PANE
displayName
: The name displayed for the filler item (usually blank). Example:" "
amount
: The number of items in the filler stack. Example:1
lore
: A list of strings for the item's lore (usually empty). Example:
3. Navigation Buttons
Next-Page
: Defines the button used to navigate to the next page.Example:
Previous-Page
: Defines the button used to navigate to the previous page.Example:
close
: Defines the button used to close the inventory.Example:
goBack
: Defines the button used to return to the main menu.Example:
4. Settings
The Settings
section is where you define your custom options for this page. The id
field serves as a placeholder for unique identifiers. Each setting added here must reference a valid configuration or custom logic.
Adding Multiple Pages
To create multiple pages:
Create separate YAML files for each page inside the
Pages
folder. Example:Ensure each page file follows the required layout shown above.
Use
Page-Count
and the navigation buttons (Next-Page
,Previous-Page
) to enable seamless navigation between pages.
Last updated