Guides · 1 / 19
Overview
Thank every donation in style: the buyer's face drawn in chat, effects for everyone, GG waves with rewards, the goal of the month, top donors and donor tiers.
RoodyDonations makes every donation an event: an announcement with the buyer's face drawn in chat, effects for everyone, a GG wave with rewards, the goal of the month, top donors and donor tiers. Everything can be changed in game from menus.
In these docs
1
Installation
It needs Paper 1.20.4 or newer (and forks) and Java 17 or newer. Optional: PlaceholderAPI, SkinsRestorer (faces on offline-mode servers).
2
The store's command
From the console, for any store (Tebex, CraftingStore, your own...):
3
Packages
packages.yml (or /donations admin Packages) says what happens for each donation. A donation finds its package by the name the store sends…
4
The announcement
Its lines are in lang/<language.yml under announcement: top, beside (up to 8 lines next to the face, more go under it) and bottom. A line…
5
Effects
effects.yml (or /donations admin Effects) has the effect packs the packages play when they are announced: for everyone, only the buyer, or…
6
GG waves
After a donation (waves.yml auto-start, min-amount, or the package's wave), or by hand with /ggwave start <player [amount] [seconds], a GG…
7
The goal
goal.yml (or /donations admin Goal): an amount for each month, week or day (or manual, until /donations goal reset), in your time zone. It…
8
Donor tiers
tiers.yml (or /donations admin Tiers): ranks by what a player gave in all (Bronze from 10, Silver from 50...). Reaching one runs its…
9
Rewards for offline buyers
What needs the player (buyer-must-be-online, or lines with [player], [message], [sound]) waits in the database and is given when they…
10
Menus
/donations opens the players' menu: the goal, the top donors with their heads (this period or all time), the last donations, your own…
11
Commands
More names for the commands: command-aliases in config.yml (/donation, /dono).
12
Permissions
13
Placeholders
With PlaceholderAPI (%roodydonations<name%):
14
Discord
discord in config.yml (or the Discord menu): a webhook of your channel (Channel settings Integrations Webhooks), no bot needed. It posts…
15
Networks
Put the same jar on your Velocity proxy and, in every server, network.enabled: true, a different network.server-id, the same…
16
For developers
Package dev.roody.roodydonations.api: DonationEvent (before saving and announcing, cancellable), WaveStartEvent (cancellable),…
17
Languages
English and Spanish included (lang/en.yml, lang/es.yml); copy one as lang/<code.yml for another. per-player-language: true shows each…
18
Files
What each file holds when the plugin creates it (in plugins/RoodyDonations/). Delete a file and restart to get it back like this.