Skip to content

smartcmd/Sidebar

Repository files navigation

📊 Sidebar Plugin for AllayMC

A customizable sidebar plugin for AllayMC Bedrock Edition servers.

✨ Features

  • ✅ Display customizable sidebar on the right side of the player's screen
  • 📝 Fully configurable sidebar title and content
  • 🔧 Supports PlaceholderAPI variables
  • 🔁 Configurable auto-refresh interval
  • ♻️ Hot-reloadable using /plugin reload Sidebar

📦 Installation

  1. 📁 Place the generated Sidebar-x.y.z-shaded.jar into your server's plugins directory
  2. ✔️ Ensure PlaceholderAPI is installed
  3. 🚀 Start the server — the plugin will generate the configuration file automatically

⚙️ Configuration

The configuration file is located at:

plugins/Sidebar/config.yml
# Update period (in ticks, 20 ticks = 1 second)
update_period: 20

sidebar:
  # Sidebar title
  title: Welcome to AllayMC!

  # Sidebar content (each line is a list item)
  content:
    - "Name: §a{player_name}"
    - "Ping: §a{ping}"
    - "Pos: §a{x},{y},{z}"
    - "Dimension: §a{dimension_id}"
    - "Online: §a{online}/{max_online}"
    - "Time: §a{month}/{day}/{hour}"

🔁 PlaceholderAPI Support

All text fields (title, content, messages, commands) support 🔧 PlaceholderAPI placeholders.

📚 For a complete list, see: 👉 https://github.com/AllayMC/PlaceholderAPI

🧩 Commands

The plugin itself does not add custom commands. Use AllayMC’s built-in hot reload:

/plugin reload Sidebar

🛠️ Building

./gradlew shadowJar

📁 The output JAR will be generated at:

build/libs/Sidebar-0.1.0-shaded.jar

📚 Dependencies

  • 🧱 AllayMC API 0.18.0+
  • 🔧 PlaceholderAPI

📄 License

🪪 This project is open source and released under the MIT License.

About

Sidebar plugin for Allay server

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages