RoseStacker
repository·master·Indexed 41 days ago
https://github.com/rosewood-development/rosestackerA 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.
What's inside RoseStacker
- RoseStacker is a plugin designed to stack mobs, items, spawners, and blocks. It provides new gameplay functionality while helping to reduce server lag by minimizing the number of loaded entities and items in your worlds.
Access RoseStacker documentation and support
masterFor detailed information, configuration guides, and usage instructions, refer to the official RoseStacker Wiki.
If you encounter bugs, have questions, or need support, you can join the RoseStacker Discord server.
Check RoseStacker server compatibility
masterRoseStacker 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=trueSpecify a stacked block type via CLI argument
masterWhen using commands that require a block type, you must provide a valid MinecraftMaterialname. The argument is case-insensitive. If the provided input does not match any validMaterialname, the command will fail with an error referencing the input provided.RoseStacker CLI subcommands reference
masterThe following subcommands are available under the
rs(orrosestacker/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.
Available suggestions for stacked block types
masterWhen using command autocompletion, the available suggestions for block types are limited to the materials currently configured as stackable in theStackSettingManager. These suggestions are provided in lowercase.Available argument handlers in RoseStacker
masterRoseStacker 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)Reference: stacktool command details
masterTechnical details for the
stacktoolcommand implementation.Command: stacktool Permission: rosestacker.stacktool Arguments: - target (optional): PLAYER Description Key: command-stacktool-descriptionAvailable entity type suggestions
masterThe CLI provides suggestions for valid entity types. These suggestions are filtered to only include entity types that are currently configured as stackable in theStackSettingManagerand possess spawn eggs. Suggestions are provided in lowercase.Specify the stacked entity type via CLI
masterWhen using commands that require a stacked entity type, you must provide a validEntityTypename. The argument is case-insensitive. If the provided name does not match any valid BukkitEntityType, the command will fail with an error referencingargument-handler-stacktype.View RoseStacker statistics with the /stats command
masterUse the
/statscommand 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.
/statsGive stacked entities with /give entity
masterUse the
entitysub-command to give a player stacked entity spawn eggs.Arguments:
player(Required): The target player.material(Required): The material/entity type (usesSTACKED_ENTITY_TYPEhandler).entityType(Required): The specific entity type (usesSTACKED_ENTITY_AMOUNThandler).amount(Optional): The number of stacks to give. Defaults to 1 if not specified.
/give entity <player> <material> <entityType> [<amount>]