RulesGUI 1.1.6

Name: RulesGUI
SKU: /p/7654
Availability: InStock

Displays server rules in an interactive and customizable graphical interface.

Overview Reviews Updates Discussion Materials

Present your Minecraft server rules with style and ease using RulesGUI, a plugin for Spigot servers that displays the rules to players through a fully customizable graphical interface (GUI).

Main Features

Graphical rules interface: Display your server rules in a visual, easy-to-navigate menu tailored to your server's configuration.
Support for interactive books: Players can open books from menu items to view the rules.

Support for categories: Organize rules into different categories or sections within the graphical interface.

Command execution: Configure actions or commands to be executed when clicking on specific menu items.

Support for custom heads: Allows displaying heads with custom textures in the GUI.
Configurable commands: The plugin allows defining multiple commands to open the GUI, adapting to different languages or server preferences.
Multilanguage support: Includes language files (e.g., English and Spanish) to customize all plugin messages and texts.
Inserting links in books: With this feature, you can add links to text within books using the syntax: (<text>)[<link>]
Inserting commands in books: With this feature, you can embed commands into text within books so that when the user clicks on the text, the command is executed automatically, using the syntax: (<text>){<command>}
Hex color support: You can now use hexadecimal colors in the rules interface to make it more colorful and visually appealing. For example, to use a hex color, type &#f5424e.
Hover text in books: Use the hover text system so that when you move the cursor over a piece of text, an informational tooltip appears above it. For example, you can use it like this: (text)[link]<text>

rulesgui.use - Access to the main /rulesgui command.

rulesgui.rules - Access to view the graphical rules interface.

rulesgui.reload - Permission to reload the plugin with /rulesgui reload.

config.yml:

# RulesGUI Configuration File
# This file contains general settings for the plugin's operation

# Command settings
# Configure the commands that players can use to interact with the plugin
commands:
  # The command name(s) for opening the rules GUI (without the slash)
  # You can set multiple commands by separating them with commas
  # Example: 'rules, reglas, normas, info, help'
  # Each command will be registered separately and will open the rules GUI
  # The default 'rules' command is already included in plugin.yml
  # Changes will take effect after a server restart or /rulesgui reload
  rules: 'rules'

# Language settings
# Set the language for plugin messages
# Currently supported languages: en (English), es (Spanish)
language: 'en'

# Messages (DEPRECATED - Use language files instead)
# These will be removed in future versions
messages:
  no-permission: '&cYou do not have permission to use this command.'  # Shown when a player lacks permission
  reload-success: '&aRulesGUI has been reloaded successfully!'        # Shown after a successful reload
  unknown-command: '&cUnknown command. Use /rulesgui for help.'       # Shown for invalid subcommands

# Plugin settings
# Advanced configuration options
settings:
  debug: false  # Set to true to enable debug logging (helpful for troubleshooting)
               # This will output additional information to the console

# Permissions:
# rulesgui.use - Access to the main /rulesgui command
# rulesgui.rules - Permission to open the rules GUI
# rulesgui.reload - Permission to reload the plugin configuration

inventory.yml:

# RulesGUI Inventory Configuration

# This file controls the layout, appearance and behavior of all GUI inventories

# Color Code Support:

# - Legacy colors: &a, &b, &c, &d, &e, &f, &0-9, &l (bold), &m (strikethrough), etc.

# - Hex colors: &#RRGGBB (example: &#80ffd9 for cyan, &#ff5555 for red)

# Main GUI Settings

# This is the first screen players see when they use /rules

rules-gui:

title: '&#80ffd9&lServer Rules' # The title displayed at the top of the inventory (using hex color)

size: 27 # Size of the inventory (must be a multiple of 9, e.g., 9, 18, 27, 36, 45, 54)

# Items Configuration

# Each number represents a slot in the inventory (0-26 for a 3-row inventory)

# Slots are numbered left to right, top to bottom, starting from 0

items:

# Welcome item explaining the menu (slot 11)

11:

material: BOOK # Minecraft material type

name: '&#ffd700&lWelcome to Rules Menu' # Item name (supports color codes and hex colors)

lore: # Item description (supports color codes and hex colors)

- '&7This menu provides access to all server rules'

- '&7and information to help you play on our server.'

- ''

- '&#80ffd9→ Click on Rules to see the server rules'

- '&#80ffd9→ Click on Server Information for details about the server'

# Book configuration - what appears when this item is clicked

# INTERACTIVE ELEMENTS:

# - (text)[url] creates a clickable link (aqua/underlined)

# - (text){command} creates a clickable command (green/underlined)

# - (text)<hover> creates hover text (yellow/underlined)

# - (text)[url]<hover> creates a clickable link with hover text

# - (text){command}<hover> creates a clickable command with hover text

# NOTE: You can use hex colors in hover text too! Example: <&#ff5555This is red text>

book:

book-title: '&#ffd700Welcome to Our Server'

book-author: 'Server Admin'

pages: # Each string is a page in the book

          - "&#ffd700Welcome to Our Server!\n\n&7This guide will help you navigate the rules menu. We have organized our rules into different categories to help you understand how to play on our server."

          - "&#80ffd9Click on different sections to explore more.\n\n&7For more information, visit our (website)[https://www.spigotmc.org/resources/rulesgui.124462/]<&#80ffd9Click to open the plugin page>.\n\n&7Need help? Click (here){help}<&#80ffd9Executes /help command> to see available commands."

# Rules category item (slot 13)

# This opens a sub-inventory with the rules

# Optional: Add "permission" to require a permission to interact with this item

# Example: permission: "rulesgui.view.rules"

# Players without the permission will see a "Locked - No Permission" message in the lore

13:

material: WRITABLE_BOOK

name: '&c&lServer Rules'

lore:

- '&7View all server rules organized'

- '&7by category to help you play properly'

- ''

- '&a→ Click to view rules categories'

# Define which category to open (must match a category ID below)

category: "rules"

# permission: "rulesgui.view.rules" # Uncomment to require permission

# Teleport command button (slot 15)

# This executes a command when clicked

15:

material: PLAYER_HEAD

name: '&d&lTeleport to Spawn'

lore:

- '&7Click to teleport to the spawn area'

- '&7A safe place for all players'

# Custom texture for player head (optional)

      skull-texture: 'eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjFiNjM1YmM5MmRkMjAwMTFkNmU3ZDAxMjU3ZTZlYTczN2I0OWZiN2RlOTQxZDNiYmQxODc3MTA0ZmM1ZWIxZSJ9fX0='

# Command configuration - executed when clicked

command:

player-execute: 'spawn' # Command executed by the player (without /)

        # server-execute: 'tp %player% spawn'  # Command executed by the server (use %player% for the player's name)

# Fill empty slots with decorative items

# This makes the inventory look cleaner

filler:

enabled: true # Set to false to disable fillers

material: BLACK_STAINED_GLASS_PANE

name: ' ' # Empty name for a clean look

# List all slots to fill (all slots not explicitly configured above)

slots: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26]

# Categories Configuration

# Define sub-inventories that can be opened from the main menu

categories:

# Rules category - opened when clicking the rules item

rules:

title: '&c&lServer Rules' # Title of this sub-inventory

size: 27 # Size of the inventory (must be a multiple of 9)

# Back button configuration - returns to the main menu

back-button:

enabled: true # Set to false to disable the back button

slot: 18 # Position of the back button

material: PLAYER_HEAD

name: '&2&l« Back to main menu'

lore:

- '&7Return to the main rules menu'

      skull-texture: 'eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzJmZjhhYWE0YjJlYzMwYmM1NTQxZDQxYzg3ODIxOTliYWEyNWFlNmQ4NTRjZGE2NTFmMTU5OWU2NTRjZmM3OSJ9fX0='

is-back-button: true # This flag identifies this as a back button

# Items in the rules category sub-inventory

items:

# Rule #1 Book (slot 11)

11:

material: BOOK

name: '&e&lRule #1: Respect'

lore:

- '&7Be respectful to all players'

- '&7No offensive language or behavior'

- ''

- '&a→ Click to read more details'

# Book configuration with interactive elements

book:

book-title: '&6Rule #1: Respect'

book-author: 'Server Admin'

pages:

            - "&6Rule #1: Respect\n\n&7All players must treat each other with respect. Harassment, bullying, or any form of disrespect will not be tolerated.\n\n&7This includes offensive language, personal attacks, and discriminatory behavior."

            - "&7Remember that there are real people behind each username. Treat others as you would like to be treated.\n\n&7If someone is bothering you, please (report them){report}<&eClick to open report menu> to staff instead of engaging in conflicts.\n\n&7Read our full (community guidelines)[https://www.spigotmc.org/resources/rulesgui.124462/]<&aOpens in your browser>.\n\n&7You can also see (examples)<&6Example:\n&7- No insults\n&7- No spam\n&7- Be kind> of respectful behavior."

# Rule #2 Book (slot 13)

13:

material: WRITABLE_BOOK

name: '&e&lRule #2: No Griefing'

lore:

- '&7No griefing or stealing'

- '&7Respect others property'

- ''

- '&a→ Click to read more details'

# Book configuration

book:

book-title: '&6Rule #2: No Griefing'

book-author: 'Server Admin'

pages:

            - "&6Rule #2: No Griefing\n\n&7Griefing and stealing are strictly prohibited on this server. This includes:\n\n&7- Breaking or placing blocks on others' builds without permission\n&7- Taking items from others' chests or containers"

            - "&7- Intentionally damaging or altering others' creations\n&7- Using TNT or other destructive methods on others' property\n\n&7Always ask for permission before interacting with another player's build."

# Rule #3 Book (slot 15)

15:

material: ENCHANTED_BOOK

name: '&e&lRule #3: No Cheating'

lore:

- '&7No hacking or using mods'

- '&7that give unfair advantages'

- ''

- '&a→ Click to read more details'

# Book configuration

book:

book-title: '&6Rule #3: No Cheating'

book-author: 'Server Admin'

pages:

            - "&6Rule #3: No Cheating\n\n&7The use of hacks, cheats, or mods that provide unfair advantages is strictly forbidden. This includes:\n\n&7- X-ray texture packs or mods\n&7- Fly hacks or speed hacks"

            - "&7- Auto-clickers or macros for combat/mining\n&7- Any mod that reveals information not normally available to players\n\n&7We use anti-cheat plugins and staff monitoring to detect and punish cheating."

# Fill empty slots with decorative items

filler:

enabled: true

material: WHITE_STAINED_GLASS_PANE

name: ' '

slots: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26]

# How to add a new item:

# 1. Choose an empty slot number not used by another item or filler

# 2. Copy an existing item section and modify it

# 3. Set material, name, and lore to your liking

# 4. Add one of these action types:

# - book: Opens a book when clicked (add book-title, book-author, and pages)

# - category: Opens a sub-inventory (add category ID that matches a section in categories)

# - command: Executes a command (add player-execute or server-execute)

#

# How to add a new category:

# 1. Add a new section under 'categories' with a unique ID

# 2. Configure title, size, and back-button

# 3. Add items to the category following the same format as above

No ratings yet

Supported MC versions

1.21

Supported server software

Spigot, Paper

Supported languages

English, Spanish

RulesGUI 1.1.6

Main Features

config.yml:

inventory.yml:

Supported MC versions

Supported server software

Supported languages

rules

gui

menu

interfaz

tool