pumpkin-api-py 0.1.0.dev0__py3-none-any.whl

pumpkin_api/wit_files/metadata.wit

@@ -0,0 +1,15 @@
+/// Plugin metadata describing the plugin and its compatibility.
+interface metadata {
+    record plugin-metadata {
+        /// Name of the plugin.
+        name: string,
+        /// Plugin version (semver).
+        version: string,
+        /// Plugin authors.
+        authors: list<string>,
+        /// Short description of the plugin.
+        description: string,
+    }
+
+    get-metadata: func() -> plugin-metadata;
+}

pumpkin_api/wit_files/permission.wit

@@ -0,0 +1,46 @@
+interface permission {
+    /// Represents the player's permission level
+    ///
+    /// Permission levels determine the player's access to commands and server operations.
+    /// Each numeric level corresponds to a specific role:
+    /// - `Zero`: `normal`: Player can use basic commands.
+    /// - `One`: `moderator`: Player can bypass spawn protection.
+    /// - `Two`: `gamemaster`: Player or executor can use more commands and player can use command blocks.
+    /// - `Three`:  `admin`: Player or executor can use commands related to multiplayer management.
+    /// - `Four`: `owner`: Player or executor can use all of the commands, including commands related to server management.
+    enum permission-level {
+        zero,
+        one,
+        two,
+        three,
+        four,
+    }
+
+    /// Describes the default behavior for permissions
+    variant permission-default {
+        /// Permission is not granted by default
+        deny,
+        /// Permission is granted by default
+        allow,
+        /// Permission is granted by default to operators
+        op(permission-level),
+    }
+
+    /// A child permission entry
+    record permission-child {
+        node: string,
+        value: bool,
+    }
+
+    /// Defines a permission node in the system
+    record permission {
+        /// The full node name (e.g., "minecraft:command.gamemode")
+        node: string,
+        /// Description of what this permission does
+        description: string,
+        /// The default value of this permission
+        default: permission-default,
+        /// Children nodes that are affected by this permission
+        children: list<permission-child>,
+    }
+}

pumpkin_api/wit_files/player.wit

@@ -0,0 +1,172 @@
+/// Represents a player connected to the Minecraft server.
+interface player {
+    use common.{hand, item-stack, position, game-mode};
+    use %world.{%world};
+    use permission.{permission-level};
+    use text.{text-component};
+    use gui.{gui};
+
+    /// Various abilities a player can have.
+    record player-abilities {
+        /// Whether the player is invulnerable to damage.
+        invulnerable:       bool,
+        /// Whether the player is currently flying.
+        flying:             bool,
+        /// Whether the player is allowed to fly.
+        allow-flying:       bool,
+        /// Whether the player is in creative mode.
+        creative:           bool,
+        /// Whether the player can modify the world.
+        allow-modify-world: bool,
+        /// The speed at which the player flies.
+        fly-speed:          f32,
+        /// The speed at which the player walks.
+        walk-speed:         f32,
+    }
+
+    /// A handle to a player on the server.
+    resource player {
+        /// Returns the player's unique UUID as a string.
+        get-id: func () -> string;
+        /// Returns the player's username.
+        get-name: func () -> string;
+
+        // Basic state
+
+        /// Returns the player's current position in the world.
+        get-position: func () -> position;
+        /// Returns the player's current yaw (horizontal rotation).
+        get-yaw: func () -> f32;
+        /// Returns the player's current pitch (vertical rotation).
+        get-pitch: func () -> f32;
+        /// Returns the world the player is currently in.
+        get-world: func () -> %world;
+        /// Returns the player's current game mode.
+        get-gamemode: func () -> game-mode;
+        /// Changes the player's game mode. Returns true if successful.
+        set-gamemode: func (mode: game-mode) -> bool;
+        /// Returns the player's locale (e.g., "en_us").
+        get-locale: func () -> string;
+        /// Returns the player's current ping in milliseconds.
+        get-ping: func () -> u32;
+
+        // Permissions & metadata
+
+        /// Returns the player's permission level (0-4).
+        get-permission-level: func () -> permission-level;
+        /// Sets the player's permission level.
+        set-permission-level: func (level: permission-level);
+        /// Checks if the player has a specific permission node.
+        has-permission: func (node: string) -> bool;
+        /// Returns the player's display name, which may include formatting.
+        get-display-name: func () -> text-component;
+
+        // Messaging & titles
+
+        /// Sends a system message to the player's chat.
+        send-system-message: func (text: text-component, overlay: bool);
+        /// Shows a large title on the player's screen.
+        show-title: func (text: text-component);
+        /// Shows a smaller subtitle on the player's screen.
+        show-subtitle: func (text: text-component);
+        /// Shows a message in the action bar area.
+        show-actionbar: func (text: text-component);
+        /// Sets the fade-in, stay, and fade-out times for titles.
+        send-title-animation: func (fade-in: s32, stay: s32, fade-out: s32);
+
+        // Teleport & kick
+
+        /// Teleports the player to a position in a world.
+        teleport: func (position: position, yaw: option<f32>, pitch: option<f32>, %world: %world);
+        /// Teleports the player to another world at a specific position.
+        teleport-world: func (world-ref: %world, position: position, yaw: option<f32>, pitch: option<f32>);
+        /// Kicks the player from the server with the specified reason.
+        kick: func (message: text-component);
+        /// Forces the player to respawn.
+        respawn: func ();
+
+        /// Opens a GUI for the player.
+        open-gui: func (gui-ref: gui);
+
+        /// Bans the player with an optional reason.
+        ban: func (reason: option<text-component>);
+        /// Bans the player's IP address with an optional reason.
+        ban-ip: func (reason: option<text-component>);
+
+        // Inventory
+
+        /// Returns the index of the currently selected hotbar slot (0-8).
+        get-selected-slot: func () -> u8;
+        /// Returns the item currently in the specified hand.
+        get-item-in-hand: func (hand: hand) -> option<item-stack>;
+        /// Returns the item in the specified inventory slot.
+        get-inventory-item: func (slot: u8) -> option<item-stack>;
+
+        // Status
+
+        /// Returns the player's current health.
+        get-health: func () -> f32;
+        /// Sets the player's current health.
+        set-health: func (health: f32);
+        /// Returns the player's maximum health.
+        get-max-health: func () -> f32;
+        /// Sets the player's maximum health.
+        set-max-health: func (max-health: f32);
+        /// Returns the player's food level (0-20).
+        get-food-level: func () -> u8;
+        /// Sets the player's food level.
+        set-food-level: func (food-level: u8);
+        /// Returns the player's food saturation level.
+        get-saturation: func () -> f32;
+        /// Sets the player's food saturation level.
+        set-saturation: func (saturation: f32);
+        /// Returns the player's food exhaustion level.
+        get-exhaustion: func () -> f32;
+        /// Sets the player's food exhaustion level.
+        set-exhaustion: func (exhaustion: f32);
+        /// Returns the player's current absorption amount.
+        get-absorption: func () -> f32;
+        /// Sets the player's current absorption amount.
+        set-absorption: func (absorption: f32);
+
+        /// Returns the player's total experience level.
+        get-experience-level:    func() -> s32;
+        /// Returns the player's progress toward the next level (0.0 to 1.0).
+        get-experience-progress: func() -> f32;
+        /// Returns the total experience points the player has.
+        get-experience-points:   func() -> s32;
+        /// Sets the player's total experience level.
+        set-experience-level:    func(level: s32);
+        /// Sets the player's progress toward the next level.
+        set-experience-progress: func(progress: f32);
+        /// Sets the player's total experience points.
+        set-experience-points:   func(points: s32);
+        /// Adds experience levels to the player.
+        add-experience-levels:   func(levels: s32);
+        /// Adds experience points to the player.
+        add-experience-points:   func(points: s32);
+
+        /// Returns whether the player is currently sneaking.
+        is-sneaking:  func() -> bool;
+        /// Sets whether the player is currently sneaking.
+        set-sneaking: func(sneaking: bool);
+        /// Returns whether the player is currently sprinting.
+        is-sprinting: func() -> bool;
+        /// Sets whether the player is currently sprinting.
+        set-sprinting: func(sprinting: bool);
+        /// Returns whether the player is currently on the ground.
+        is-on-ground: func() -> bool;
+        /// Returns whether the player is currently flying.
+        is-flying:    func() -> bool;
+        /// Sets whether the player should be flying.
+        set-flying:   func(flying: bool);
+
+        /// Returns the player's current abilities.
+        get-abilities: func() -> player-abilities;
+        /// Updates the player's abilities.
+        set-abilities: func(abilities: player-abilities);
+
+        /// Returns the player's IP address.
+        get-ip: func() -> string;
+    }
+}

pumpkin_api/wit_files/plugin.wit

@@ -0,0 +1,61 @@
+/// The main entry point for a Pumpkin plugin.
+/// This world defines the exports that the plugin must provide to the host
+/// and the imports that the host provides to the plugin.
+package pumpkin:plugin;
+
+world plugin {
+    use context.{context};
+    use event.{event};
+    use server.{server as server-instance};
+    use command.{command-sender, consumed-args, command-error};
+
+    // --- Host-provided imports ---
+
+    /// Provides logging capabilities to the plugin.
+    import logging;
+    /// Provides GUI creation and management.
+    import gui;
+    /// Provides scoreboard management.
+    import scoreboard;
+    /// Provides global server information and player lookup.
+    import server;
+    /// Provides text component building and formatting.
+    import text;
+    /// Provides command registration and argument parsing.
+    import command;
+    /// Provides the plugin execution context.
+    import context;
+    /// Provides internationalization and translation support.
+    import i18n;
+    /// Provides task scheduling for delayed or repeating logic.
+    import scheduler;
+
+    // --- Plugin-provided exports ---
+
+    /// Called by the host once to initialize the plugin.
+    /// Internal use only; plugins should use the `register_plugin!` macro.
+    export init-plugin: func();
+
+    /// Called when the plugin is being loaded.
+    /// Use this to register commands, events, and perform initial setup.
+    export on-load: func(context: context) -> result<_, string>;
+
+    /// Called when the plugin is being unloaded.
+    /// Use this to save data and clean up resources.
+    export on-unload: func(context: context) -> result<_, string>;
+
+    /// Provides plugin metadata (name, version, etc.) to the host.
+    export metadata;
+
+    /// Common types used across the API.
+    export common;
+
+    /// Dispatches an event to the plugin for handling.
+    export handle-event: func(event-id: u32, server: server-instance, event: event) -> event;
+
+    /// Dispatches a command execution to the plugin.
+    export handle-command: func(command-id: u32, sender: command-sender, server: server-instance, args: consumed-args) -> result<s32, command-error>;
+
+    /// Dispatches a scheduled task execution to the plugin.
+    export handle-task: func(handler-id: u32, server: server-instance);
+}