CustomSetting Plugin

CustomSetting is a PocketMine-MP plugin that provides a persistent custom form for server settings, allowing you to create a customizable information page for your Minecraft Bedrock server.

• Settings form for all players
• Customizable form content via form.json
• Rich text formatting support

1. Player Opens Settings:

   • The player accesses the settings menu on their device.

2. Plugin Detects and Sends Forms:

   • The plugin detects when the player opens the settings and immediately sends a series of 5 forms (pre-configured settings pages) to the player.
   • This ensures the player receives the forms, even if the initial form was sent before they opened the settings.

3. Handling Early Closure:

   • If the player closes the settings before all 5 forms are sent, the plugin detects this and automatically stops sending forms.

• Guaranteed Delivery: Sending multiple forms ensures the player receives the settings, even if they experience a delay in opening the settings menu.
• Efficient Handling: The plugin stops sending forms if the player closes the settings early, avoiding unnecessary actions.
• Fast Detection: The plugin actively monitors the player's actions to ensure timely and efficient form delivery.

1. Download the plugin
2. Place in your server's plugins/ directory
3. Restart the server

To edit the settings page, check the rest of my documentation. You can use color codes and set custom icons (such as your server logo). If you encounter any issues, feel free to post them on the GitHub repository.

(!) If you want to create your own plugin or use another plugin that displays settings pages to clients (players), they may interfere with CustomSetting.

You can combine multiple formatting codes for creative text styling:

• §l§9Bold Blue Text
• §c§oRed Italic Text
• §6Gold Text

The plugin supports three ways to set the form icon:

1. Minecraft Default Textures

"icon": {
  "type": "path",
  "data": "textures/items/cookie"
}

Some popular texture paths:

• textures/items/cookie
• textures/items/diamond
• textures/items/book_written
• textures/items/paper
• textures/items/compass

2. Base64 Encoded Image

"icon": {
  "type": "url",
  "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
}

To create a base64 icon:

• Use an image editing tool
• Resize to 64x64 pixels
• Convert to PNG
• Use an online base64 encoder

3. URL Image (not recommended due to potential loading issues)

"icon": {
  "type": "url",
  "data": "https://example.com/icon.png"
}

{
  "type": "custom_form",
  "title": "§eServer Info",
  "icon": {
    "type": "path",
    "data": "textures/items/diamond"
  },
  "content": [
    {
      "type": "label",
      "text": "§l§6Welcome to Our Server!§r"
    },
    {
      "type": "label",
      "text": "§bRules:§r\n§a1.§f Be respectful\n§a2.§f No griefing"
    }
  ]
}

The plugin configuration is stored at: plugin_data/CustomSetting/form.json

• Ensure form.json is valid JSON
• Check server logs for any error messages
• Verify file permissions
• The plugin will generate a default form if form.json is missing or invalid

Contributions are welcome! Open an issue or submit a pull request.

Copyright 2025 @nikipuh

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License: https://opensource.org/license/mit