Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxcapades/spigot-compression-plugin
Simple Spigot plugin that allows "compressing" inventory stacks for storage of large quantities of items.
https://github.com/foxcapades/spigot-compression-plugin
Last synced: 9 days ago
JSON representation
Simple Spigot plugin that allows "compressing" inventory stacks for storage of large quantities of items.
- Host: GitHub
- URL: https://github.com/foxcapades/spigot-compression-plugin
- Owner: Foxcapades
- Created: 2021-12-05T21:10:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T02:23:42.000Z (7 months ago)
- Last Synced: 2024-10-17T01:19:19.203Z (20 days ago)
- Language: Kotlin
- Homepage:
- Size: 585 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: readme.adoc
Awesome Lists containing this project
README
= Spigot Block Compression Plugin
:toc:
**FOR THE HOARD!**
A small plugin for SpigotMC that allows players to "compress" and "decompress"
stacks of items or blocks for easier storage or transport of mass quantities.
++++
++++
9 of any of the configured allowable items/blocks may be compressed into a
single item/block. This process may be repeated to compress a stack up to 9
times to store a maximum of 24,794,911,296 items in a full (64) stack of fully
compressed items.
++++
++++
https://imgur.com/a/aedDwCR[Video/Screenshots (Imgur)]
== Commands
`/compress`::
Command to open the Compression Workbench user interface. +
+
*Requires Permission*: `block-compression.gui`
`/zip`::
Alias of `/compress`.
`/bcgive`::
Usage: `/bcgive `
+
Command to give a stack of compressed items to a target player.
+
*Requires Permission*: `block-compression.give`
`/bcreload`::
Usage: `/bcreload`
+
Command to reload the the plugin config and the allowed compressible
items/blocks list files from disk without having to restart the server.
+
*Requires Permission*: `block-compression.reload`
== Permissions
`block-compression.gui`::
Grants access to the `/compress` and `/zip` commands as well as accessing the
compression workbench via block interaction.
`block-compression.gui.command`::
Grants access to the `/compress` and `/zip` commands.
`block-compression.gui.block`::
Grants access to accessing the compression workbench via block interaction.
`block-compression.give`::
Grants access to the `/bcgive` command.
`block-compression.reload`::
Grants access to the `/bcreload` command.
== Configuration
Block interaction to open the compression workbench can be configured with the
plugin's `config.yml` file:
.plugin.yml
[source, yaml]
----
# Configures whether/how players can open the compression workbench by
# interacting with a block, while optionally holding a "key" item to enable the
# interaction.
#
# For example, if set to `target: minecraft:fletching_table` and
# `holding: minecraft:diamond` then players with the correct permissions will be
# able to open the crafting workbench by right clicking a diamond against a
# fletching table.
open-on-interact:
# Whether opening the crafting workbench by interacting with a block is
# enabled.
#
# Values: true|false
enabled: true
# ID of the target block that must be interacted with (right clicked on) to
# open the crafting workbench.
#
# Values:
target: minecraft:fletching_table
# ID of the item that must be held by the player when interacting with
# (right clicking) the target block.
#
# To disable an item requirement, set to `minecraft:air`.
#
# Values:
holding: minecraft:diamond
----
Additionally the plugin reads what blocks are allowed to be (de)compressed from 2 files:
https://github.com/Foxcapades/Spigot-Compression-Plugin/blob/main/src/main/resources/compressible-items.txt[`compressible-items.txt`]
and https://github.com/Foxcapades/Spigot-Compression-Plugin/blob/main/src/main/resources/compressible-blocks.txt[`compressible-blocks.txt`].
These files will be created in the plugin's config directory on first load.