Here’s the updated README.md with the requested changes to include the CONTEXT usage in each plugin, with clear documentation in TypeScript style. The CONTEXT object is extended in every plugin attribute example to ensure consistency and integration with the global context.

---

STOOL-API

Report Issue

STOOL-API is a feature-rich API for Minecraft Bedrock Edition ScriptAPI development, designed to facilitate server tool creation and improve player interaction through customizable and developer-friendly tools.

Note: This API is currently in development, so features may change in future versions.

Requirement: Make sure Education Edition & Beta-API are enabled.

---

Table of Contents

• Features
• Configuration
• Plugin System
• Command Handlers
  • Command Handler Structure
• Installation
• Usage
• Examples
  • Custom Prefix Example
  • Admin Command Example
• Contributing
• License
• Creator

---

Features

• Easy configuration through JavaScript files.
• Customizable command system with support for prefixes and role-based access.
• Built-in teleportation, warps, and home systems.
• Robust logging and broadcast options.
• Player management capabilities, including role assignments, balances, and custom data storage.
• Plugin-based architecture for modular development.

---

Configuration

The API is configured via config.js, which manages command prefixes, admin tags, logging, and other settings.

• Config Path: config.js

---

Plugin System

STOOL-API supports a modular plugin system. You can easily add or remove plugins without altering core files. Plugins are registered in register.js for easy management.

• Plugin Registration Path: register.js

---

Command Handlers

The command handler system lets you define and organize commands efficiently. You can create commands with custom help messages, categories, and admin-only restrictions.

Command Handler Structure

Each command handler is a function that defines command logic, such as what actions to execute based on player input. Handlers also allow for custom prefixes, role-based restrictions, and usage help messages.

Handler Structure Example:

/**
 * Command handler structure example.
 * @type {Command<function>}
 */
let handler = function(event, context) {
  // Command logic goes here
};

handler.commands = ["command_name"];
handler.helps = ["command_name <arg>"];
handler.category = "category_name";
handler.admin = false; // Set to true for admin-only commands
handler.custom_prefix = ["!", "/"]; // Optional custom prefixes

• handler.commands: An array of command names.
• handler.helps: Usage examples for the command.
• handler.category: The category under which the command falls.
• handler.admin: Boolean to restrict the command to admins.
• handler.custom_prefix: Array of prefixes specific to the command.

---

Installation

1. Clone the repository:

   git clone https://github.com/nperma/STOOL-API.git

2. Install dependencies:

   npm install

3. Update the config.js file as needed.

4. Register plugins in register.js.

---

Usage

STOOL-API automatically loads registered plugins. To create new plugins:

1. Define a command handler.
2. Register it in register.js.
3. Reload the server (/reload) to apply changes.

---

Examples

Find example plugins here: plugins

Custom Prefix Example

Define custom prefixes to allow commands to be triggered with multiple options.

/**
 * Custom Prefix Command Example
 * 
 * @param {Object} ev - The event object for the command.
 * @param {Object} CONTEXT - The global context containing required plugins and services.
 * @param {string} CONTEXT.text - The text provided by the player.
 * @param {Object} CONTEXT.mc - Minecraft-related API object for interaction with the world.
 */
let handler = function(ev, { text, mc }) {
  if (text) {
    mc.world.sendMessage(text);
  } else {
    ev.sender.sendMessage("-_-");
  }
};

handler.commands = ["say"];
handler.helps = ["say <text>"];
handler.custom_prefix = ["p.", "np!"];
handler.category = "twst";

export default handler;

Admin Command Example

Restrict commands to admin users by setting handler.admin = true.

/**
 * Admin Command Example
 * 
 * @param {Object} ev - The event object for the command.
 * @param {Object} CONTEXT - The global context containing required plugins and services.
 * @param {string} CONTEXT.text - The text to be broadcasted.
 * @param {Object} CONTEXT.tools - Minecraft tools for additional game operations.
 */
let handler = function(ev, { sender, tools, text }) {
  tools.broadcast(`§d@${sender.name}§g: §e${text}`, `§5§l[§dMSB§5]§r §7»§r`);
};

handler.commands = ["msb", "modsbroadcast"];
handler.helps = ["msb <text>"];
handler.admin = true;
handler.category = "admin";

export default handler;

---

Custom Context Usage in Plugin Attributes

For every plugin, it's essential to extend the CONTEXT object to provide access to Minecraft-specific data, databases, and more. Here's how to extend the CONTEXT in different parts of a plugin:

Example: plugin_after attribute

/**
 * Example plugin after hook
 * 
 * @param {Object} ev - The event object for the hook.
 * @param {Object} CONTEXT - The global context containing required plugins and services.
 * @param {string} CONTEXT.text - The text provided by the player.
 * @param {boolean} CONTEXT.isAdmin - Boolean indicating if the player is an admin.
 * @param {Object} CONTEXT.tools - Minecraft tools for interaction with the game world.
 */
attr.after[plugin_after].call(this, ev, {
  sender,
  message,
  attribute: usePlugin,
  isAdmin,
  isDev,
  isOwner,
  command: args?.slice(usePrefix.length ?? 0).shift().toLowerCase(),
  prefix: usePrefix,
  text: args.slice(0).join(" "),
  ...CONTEXT
});

Example: plugin_static attribute

/**
 * Example static plugin function
 * 
 * @param {Object} CONTEXT - The global context containing required plugins and services.
 * @param {Object} CONTEXT.mc - Minecraft-related API object for interaction with the game world.
 * @param {Set} CONTEXT.DEVS - Set of developer names.
 * @param {Set} CONTEXT.OWNERS - Set of owner names.
 */
attr.static[plugin_static].call(this, {
  ...CONTEXT,
  DEVS,
  OWNERS
});

Example: plugin_interval attribute

/**
 * Example interval plugin function
 * 
 * @param {Object} CONTEXT - The global context containing required plugins and services.
 * @param {Object} CONTEXT.mc - Minecraft-related API object for interaction with the game world.
 * @param {Object} CONTEXT.player - The player object.
 * @param {Set} CONTEXT.DEVS - Set of developer names.
 * @param {Set} CONTEXT.OWNERS - Set of owner names.
 */
attr.interval[plugin_interval].call(this, {
  player,
  sender: player,
  isAdmin: player.hasTag(config.admin_permission),
  isDev: DEVS.has(player.name),
  isOwner: OWNERS.has(player.name),
  ...CONTEXT
});

Documentation for Context

The CONTEXT object provides access to all necessary dependencies and services throughout your plugin's lifecycle. It's essential for your plugin to correctly reference and use the context, as shown in the examples above. The context is made up of various elements such as:

• mc for Minecraft API interaction.
• tools for additional helper tools.
• server and Database for interacting with the server and database management.
• plugins for managing plugin functionalities.
• attr for accessing various plugin attributes like default, static, after, interval.

---

Contributing

We welcome contributions to STOOL-API! Feel free to submit a pull request or open an issue in our GitHub repository.

Contribution Guidelines

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to your branch (git push origin feature/my-feature).
5. Create a pull request.

---

License

This project is licensed under the MIT License. See