Requirements

Steps

1. Place GrimsDonationCenter-0.7.2.jar in the server's plugins folder.
2. Restart the server normally. Don't hot-load the plugin.
3. Review the files created under plugins/GrimsDonationCenter/.

Creating a physical Trash Can

1. Place a chest or double chest.
2. Attach a sign directly to it, or place a standing sign on top.
3. Put one accepted phrase on any sign line.

trashcan
trash can
[trashcan]
[trash can]

The sign updates when it's linked. After that it behaves like a normal sign and can be edited, dyed, or waxed without removing the saved link. Players donate by placing items inside and closing the chest.

Creating a Donations access chest

Attach a sign to an empty chest using one of these phrases:

donations
[donations]
donation center
[donation center]

Only administrators can create or remove this link. Interacting with the chest or sign opens the Donation Center menu instead of the chest's inventory. Players still need donationcenter.use to browse it.

Creating demo chests

Use one of these attached-sign phrases for a read-only catalog with one of each available item:

demo
demo one
[demo one]

Use these for full stacks:

demo stack
[demo stack]

Demo catalogs help you check item sorting and don't affect stored items.

/donations supports tab completion. Type /donations, add a space, and press Tab to see the commands available to you. Commands such as demo, sanitize, and resolve also suggest their next option.

donationcenter.command-deposit must be granted explicitly. The command menu deletes equipment below 40% condition at once, because it has no chest to leave it in.

Command access

Allow players to open the catalog with /donations:

access:
  donations-command-enabled: true

Set this to false to require a physical Donations access chest. Administrative subcommands keep working either way.

Mobile withdrawal forms

Grims Client Checker decides who gets the mobile withdrawal form. Donation Center no longer checks clients itself, and the former crossplay.mobile-withdrawal-forms setting is no longer read. You can delete it from older configs.

Players choose their own style with /gcc menu. Use /gcc check to see what a player's client reports and which menu they get. The Java-only /donations deposit menu also uses Client Checker to recognize Java players.

Pricing providers

PlaceholderAPI

PlaceholderAPI support registers automatically when PlaceholderAPI is installed and placeholders.enabled is true. Useful placeholders include:

%grimsdonationcenter_item_count%
%grimsdonationcenter_shop_value%
%grimsdonationcenter_total_withdrawn_items%
%grimsdonationcenter_player_items%
%grimsdonationcenter_player_value%
%grimsdonationcenter_player_rank%
%grimsdonationcenter_player_taken_items%
%grimsdonationcenter_player_taker_rank%
%grimsdonationcenter_top_1_name%
%grimsdonationcenter_top_1_score%
%grimsdonationcenter_top_taker_1_name%
%grimsdonationcenter_top_taker_1_items%

Top donor and taker placeholders support positions 1 through 10. Replace the number in the placeholder.

The Donation Center tracks total donated items, estimated donation value, and items withdrawn during the configured 30-day period.

The reporting window

Exactly one statistics window must be enabled:

statistics:
  rolling-last-30-days: true
  fixed-30-day-periods: false

Pick one. Enabling both, or neither, makes the plugin disable itself for safety.

Ranking

Choose how the donor leaderboard is ranked:

statistics:
  leaderboard-mode: "ITEM_COUNT"

Use SHOP_VALUE instead to rank by estimated donation value.

Leaderboard signs

Enable up to four leaderboard displays:

leaderboard-signs:
  enabled: true
  maximum-signs: 4

The signs can show the top three donors and the top three players withdrawing items. Run:

Then right-click signs in this order:

1. Top donor names and scores.
2. Full donor totals.
3. Top withdrawal names.
4. Full withdrawal totals.

Run the command again to finish linking early.

Item sanitization

item-sanitization.enabled controls cleaning for whitelisted materials. Cleaning removes names and custom item data and turns the item into a fresh base item. It's off by default.

Use the /donations sanitize commands to manage the whitelist and turn cleaning on or off without typing material names by hand.

Content resolution

Content resolution cleans and combines items already in Donation Center storage. Always run the preview first:

/donations resolve preview
/donations resolve confirm

The preview doesn't change any data. Confirming creates a backup before changing stored contents.

content-resolution.include-tools-and-armor controls whether existing equipment is included. It's off by default, which leaves stored armor and tools unchanged.

Content-resolution backups

Before /donations resolve confirm changes stored contents, it creates a backup inside:

plugins/GrimsDonationCenter/backups/

/donations resolve backup reports the latest backup created during the current server session.

Restoring a backup by hand

1. Stop the server completely.
2. Keep a copy of, or remove, donations.db, donations.db-wal, and donations.db-shm.
3. Copy the chosen backup into plugins/GrimsDonationCenter/.
4. Rename the copied backup to donations.db.
5. Start the server.

Never replace the database while the server is running.

Plugin files

Operational safety

• Deposits are saved before accepted physical items are cleared.
• Items are saved after the final viewer closes a Trash Can.
• Only one player can use a Trash Can at a time.
• Hoppers are blocked.
• Pistons and explosions can't move or destroy linked blocks.
• Deposits, withdrawals, rejections, and cleanup events are audited.
• Primary data is stored in plugins/GrimsDonationCenter/donations.db.

If something looks wrong