Skip to content

SjnExe/AddonExe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

AddonExe for Minecraft BE

Latest Release GitHub All Releases Minecraft BE Version GitHub Issues Status: Stable Release Discord Server

Warning

Do not use pre-release versions for public servers.

Pre-releases are intended for development and testing purposes only. They may be unstable, contain bugs, or cause unintended issues. For the best experience, please use the latest stable release.

Note

Always Use the Latest Version This addon is designed for and tested on the latest stable version of Minecraft Bedrock Edition. It is intended for servers and realms that are kept up-to-date. Support for older versions of Minecraft is not maintained.


The ultimate scripting-based solution for your Minecraft Bedrock Edition world! Designed to be robust, highly configurable, and packed with features to ensure fair and fun gameplay.


โœจ Why Choose AddonExe?

  • Scripting Power: Built entirely with the Minecraft Scripting API, offering flexibility and complex detection logic not always possible with traditional methods.
  • Comprehensive Detection (Coming Soon): While currently a powerful moderation tool, a full suite of cheat detections is in active development.
  • User-Friendly Tools: Manage your server with ease using an intuitive in-game UI (/panel) and extensive slash commands, which can be used in-game, from the server console, or via a chat-based fallback (e.g. !panel).
  • Highly Customizable: Fine-tune almost every aspect, from feature toggles to command permissions, to perfectly suit your server's needs.
  • Active Development: Continuously updated with new features, improvements, and compatibility for the latest Minecraft versions.
  • Open & Documented: With clear documentation and an open codebase, understand how it works and even contribute!
  • Enhanced Stability: Includes robust error handling and a watchdog to prevent script-related server crashes, ensuring a more stable experience.

๐ŸŒŸ Core Features at a Glance

This addon is packed with features to keep your server clean:

  • ๐Ÿ› ๏ธ Powerful Admin & Moderation Tools:
    • A universal, dynamic in-game UI panel that shows each player only the buttons they are permitted to see. The panel item can be crafted by anyone, or spawned directly with the admin-only /panel command.
    • Enhanced Player Management Panel:
      • View online players, sorted by rank and name.
      • Player names are clearly marked with (Owner), (Admin), and (You) suffixes.
      • Perform a wide range of actions: Kick, Ban/Unban, Mute/Unmute, Freeze, View/Clear Inventory, Teleport.
    • New Commands: /clear (clear inventory), /ecwipe (wipe ender chest), /invsee (view inventory).
    • Extensive slash commands for all administrative functions (Note: a ! prefix is available as a fallback).
  • ๐Ÿ’พ Persistent Player Data Management:
    • Mutes and bans are saved across player sessions using dynamic properties.
  • โš™๏ธ Highly Configurable System:
    • Toggle major features, customize messages, and define all permissions and ranks in easy-to-edit configuration files.
  • ๐Ÿ… Flexible Rank System:
    • Define Owner, Admin, Member, and custom roles with specific permissions and visual chat/nametag prefixes.
  • ๐Ÿ“ž Teleport Request System (TPA/TPAHere):
    • Allows players to request teleports to others or summon others, with configurable cooldowns and warmup periods.
  • โœจ Player & Server Utilities:
    • Economy & Bounties: A simple economy system with player balances, payment commands, and a full bounty system.
    • In-Game Shop: A fully-featured, GUI-based shop where players can buy and sell items. Admins can configure all items and prices from an in-game panel.
    • Homes: Allows players to set and teleport to their own personal "homes".
    • Kits: A system for players to claim predefined kits of items with cooldowns.

Note

Cheat Detection Suite Coming Soon! A comprehensive suite of cheat detections is under active development and will be added in a future update.

โžก๏ธ Dive Deeper: For a full list and details of all features, check out our Features Overview in the Docs!


๐Ÿš€ Installation & Setup

We recommend the following manual installation method, as it makes future configuration much easier.

  1. Download: Grab the latest .mcaddon file from our GitHub Releases.
  2. Extract the Packs (Recommended Method):
    • Do not open the .mcaddon file directly. Instead, rename it to end in .zip (e.g., AddonExe.mcaddon -> AddonExe.zip).
    • Unzip the file. Inside, you will find two folders: AddonExeBP (the Behavior Pack) and AddonExeRP (the Resource Pack).
    • Move these two folders into your Minecraft's behavior_packs and resource_packs folders, respectively.

    Why this method? Installing the folders directly makes it simple to find and edit the config.js file later. Installing a sealed .mcpack or .mcaddon makes configuration much more difficult.

  3. Apply to Your World:
    • Open Minecraft and go to your world's settings.
    • Apply both AddonExeBP and AddonExeRP to your world.
  4. Enable World Settings (CRITICAL!):
    • In your world settings, go to the "Game" section and enable "Activate Cheats". This is required for slash commands to work.
    • Next, go to the "Experiments" section and enable the "Beta APIs" toggle. This addon relies on beta Minecraft Scripting API features and will not function without this setting enabled.

    For Bedrock Dedicated Server (BDS) users:

    • You must also edit your server.properties file and set allow-cheats=true.
    • Commands can be run directly from the server console using the leading slash (e.g., /xreload). See the Commands List for more details.
  5. Prioritize: Ensure AddonExeBP is at the TOP of your behavior pack list in the world settings. This is crucial for AddonExe to function correctly.
  6. ๐Ÿ‘‘ Set Owner(s) (CRUCIAL!):
    • Now that you've installed the folders, navigate to behavior_packs/AddonExeBP/scripts/ and open config.js in a text editor.
    • Find the ownerPlayerNames setting.
    • Add your exact in-game name (case-sensitive) to the array. You can add multiple owner names.
      // Example in AddonExeBP/scripts/config.js
      ownerPlayerNames: ['YourNameHere', 'AnotherOwnerName'],
    • To apply changes to the owner list on a live server, you must use the /xreload command after saving the file.
    • Note: Failure to set an owner will not lock you out. Admin permissions can still be granted via the /function admin command or by giving a player the admin tag.
  7. ๐ŸŽฎ Explore: Join your world and open the Admin UI. Admins can get the panel item directly by typing /panel. Any player can also craft the item using a single stick.
  8. ๐Ÿ”ง Configure (Optional but Recommended):
    • Review AddonExeBP/scripts/config.js for other core settings (like the chat command prefix).
    • For detailed setup and advanced options, visit our Setup and Configuration Guide.
๐Ÿ’ก Quick Troubleshooting Tips & Full Guide

Common quick checks:

  • Enable Cheats & Beta APIs: Make sure both "Activate Cheats" and the "Beta APIs" experimental toggle are ON in your world settings.
  • Ensure AddonExeBP is at the very top of your behavior packs.
  • Verify you have added your exact, case-sensitive name to the ownerPlayerNames array in config.js.
  • Check Minecraft version compatibility (see badge above).
  • Test for conflicts with other addons, especially those modifying player behavior.

โžก๏ธ For a comprehensive guide, see our Troubleshooting Guide.

If problems persist after checking the guide, please report an issue!


๐Ÿ“– Documentation Hub

All detailed information has been moved to our Docs folder for clarity:


Performance Considerations

This addon is designed to be as lightweight as possible. However, performance can be influenced by the number of checks enabled, their sensitivity, and the server's player count. We recommend starting with default configurations and adjusting based on your server's needs.

For developers, the addon includes a basic performance profiling feature that can be enabled in config.js to help identify potential bottlenecks. For more details, see the Developer README.


๐Ÿค Contributing

Contributions are highly welcome and appreciated! Help us make this addon even better.

Project Philosophy: Our goal is to keep this addon clean, universal, and easy to maintain. A planned future feature is full internationalization (i18n) support.

Review Process: All contributions will be reviewed by SjnExe or Jules AI assistant to ensure they align with the project's goals and coding standards.

Crediting: Please note that contributions are generally not credited directly in the codebase. Significant contributions will be acknowledged in the project's changelog or a dedicated contributors file.

  • Fork & Branch: Create your own fork and make changes in a dedicated branch.
  • Code Style: Follow our ๐Ÿ“„ Coding Style Guide.
  • Test Thoroughly: Ensure your changes are stable and don't introduce new issues.
  • Document Changes: Update relevant documentation in the Docs folder if you add or modify features.
  • Pull Request: Submit your changes for review. Explain what you've changed and why.

Looking for a place to start? Check out our issues tab โ€“ we often tag issues that are great for new contributors.

โžก๏ธ For more on development processes, see our Developer README.


โค๏ธ Acknowledgements & Contributors

This addon was developed by SjnExe with significant assistance from Jules, an AI software engineer.

This project is also made possible by the community and all the developers who dedicate their time to contribute. We are incredibly grateful for every contribution, from reporting issues and suggesting new ideas to writing code and improving documentation.

โžก๏ธ You can see a list of code contributors on GitHub.


โš–๏ธ License

License: MIT

This project is licensed under the MIT License. See the LICENSE file for details.

In the spirit of open source, you are free to use, modify, and distribute this code with or without credit to SjnExe.

Thank you for using AddonExe! We hope it helps create a fairer and more enjoyable Minecraft experience for your community.