RoseStacker

repository·master·Indexed 41 days ago

https://github.com/rosewood-development/rosestacker

A Minecraft server plugin for Spigot and Paper (1.16.5 and newer) that stacks mobs, items, spawners, and blocks to improve server performance and reduce entity count. Features include a CLI for managing stacks via the /rs command, a specialized Stacking Tool, and administrative commands for giving stacked items, clearing data, and viewing real-time stacking statistics.

Tokens
2.9K
Snippets
12
Records
22
Agent score
50%

What's inside RoseStacker

  1. Check RoseStacker server compatibility

    master

    RoseStacker is compatible with Spigot and its forks. It is highly recommended to use Paper for running your server. Note that CraftBukkit servers are not compatible.

    Requirements

    • Minecraft Versions: 1.16.5 and newer.
    • Java Version: Java 17.

    Special Setup for Minecraft 1.16.5

    If you are running the plugin on a 1.16.5 server, you must use Paper (or a Paper fork) and Java 17. Additionally, you must add the following flag to your server's startup parameters: -DPaper.IgnoreJavaVersion=true

    -DPaper.IgnoreJavaVersion=true
  2. RoseStacker CLI subcommands reference

    master

    The following subcommands are available under the rs (or rosestacker/stacker) command prefix:

    • help: Displays help information.
    • reload: Reloads the plugin configuration.
    • clearall: Clears all data/stacks.
    • give: Grants items or stacks to a player.
    • stacktool: Accesses the Stack Tool functionality.
    • stats: Displays plugin statistics.
    • translate: Invokes translation commands.
  3. Available argument handlers in RoseStacker

    master

    RoseStacker provides several specialized argument handlers used within its command framework to parse specific types of data for commands. These handlers allow for type-safe input for quantities, materials, entity types, spawner configurations, and localization settings.

    // Available ArgumentHandlers:
    STACKED_BLOCK_AMOUNT      // Parses an Integer (amount of blocks)
    STACKED_BLOCK_TYPE         // Parses a Material (type of block)
    STACKED_ENTITY_AMOUNT      // Parses an Integer (amount of entities)
    STACKED_ENTITY_TYPE        // Parses an EntityType (type of entity)
    STACKED_SPAWNER_AMOUNT     // Parses an Integer (amount of spawners)
    STACKED_SPAWNER_TYPE       // Parses a SpawnerType (type of spawner)
    TRANSLATION_LOCALE         // Parses a String (translation locale)
  4. View RoseStacker statistics with the /stats command

    master

    Use the /stats command to view real-time statistics regarding the stacking operations performed by RoseStacker. This command provides a summary of active threads, the number of unique stacks, and the total count of stacked objects.

    Permissions Required:

    • rosestacker.stats

    Statistics Provided:

    • Stacking Threads: The number of threads currently dedicated to stacking.
    • Stacked Entities: The number of unique entity stacks and the total number of entities contained within them.
    • Stacked Items: The number of unique item stacks and the total number of items contained within them.
    • Stacked Blocks: The number of unique block stacks and the total number of blocks contained within them.
    • Stacked Spawners: The number of unique spawner stacks and the total number of spawners contained within them.
    • Active Tasks: The number of currently active threads in the system.
    /stats
  5. Give stacked entities with /give entity

    master

    Use the entity sub-command to give a player stacked entity spawn eggs.

    Arguments:

    • player (Required): The target player.
    • material (Required): The material/entity type (uses STACKED_ENTITY_TYPE handler).
    • entityType (Required): The specific entity type (uses STACKED_ENTITY_AMOUNT handler).
    • amount (Optional): The number of stacks to give. Defaults to 1 if not specified.
    /give entity <player> <material> <entityType> [<amount>]