Ruby-Cogs/extendedeconomy/README.md
2025-05-23 02:30:00 -04:00

94 lines
3.3 KiB
Markdown

Set prices for commands, customize how prices are applied, log bank events and more!
# [p]bankpie
View a pie chart of the top X bank balances.<br/>
- Usage: `[p]bankpie [amount=10]`
# [p]extendedeconomy
Extended Economy settings<br/>
**NOTE**<br/>
Although setting prices for pure slash commands works, there is no refund mechanism in place for them.<br/>
Should a hybrid or text command fail due to an unhandled exception, the user will be refunded.<br/>
- Usage: `[p]extendedeconomy`
- Restricted to: `ADMIN`
- Aliases: `ecoset and exteco`
- Checks: `server_only`
## [p]extendedeconomy resetcooldown
Reset the payday cooldown for a user<br/>
- Usage: `[p]extendedeconomy resetcooldown <member>`
## [p]extendedeconomy stackpaydays
Toggle whether payday roles stack or not<br/>
- Usage: `[p]extendedeconomy stackpaydays`
- Aliases: `stackpayday`
## [p]extendedeconomy autopaydayrole
Add/Remove auto payday roles<br/>
- Usage: `[p]extendedeconomy autopaydayrole <role>`
## [p]extendedeconomy view
View the current settings<br/>
- Usage: `[p]extendedeconomy view`
## [p]extendedeconomy transfertax
Set the transfer tax percentage as a decimal<br/>
*Example: `0.05` is for 5% tax*<br/>
- Set to 0 to disable<br/>
- Default is 0<br/>
- Usage: `[p]extendedeconomy transfertax <tax>`
## [p]extendedeconomy mainlog
Set the main log channel<br/>
- Usage: `[p]extendedeconomy mainlog [channel=None]`
## [p]extendedeconomy autopayday
Toggle whether paydays are claimed automatically (Global bank)<br/>
- Usage: `[p]extendedeconomy autopayday`
- Restricted to: `BOT_OWNER`
## [p]extendedeconomy eventlog
Set an event log channel<br/>
**Events:**<br/>
- set_balance<br/>
- transfer_credits<br/>
- bank_wipe<br/>
- prune<br/>
- set_global<br/>
- payday_claim<br/>
- Usage: `[p]extendedeconomy eventlog <event> [channel=None]`
## [p]extendedeconomy rolebonus
Add/Remove Payday role bonuses<br/>
Example: `[p]ecoset rolebonus @role 0.1` - Adds a 10% bonus to the user's payday if they have the role.<br/>
To remove a bonus, set the bonus to 0.<br/>
- Usage: `[p]extendedeconomy rolebonus <role> <bonus>`
## [p]extendedeconomy autoclaimchannel
Set the auto claim channel<br/>
- Usage: `[p]extendedeconomy autoclaimchannel [channel]`
## [p]extendedeconomy deleteafter
Set the delete after time for cost check messages<br/>
- Set to 0 to disable (Recommended for public bots)<br/>
- Default is 0 (disabled)<br/>
- Usage: `[p]extendedeconomy deleteafter <seconds>`
- Restricted to: `BOT_OWNER`
# [p]addcost
Add a cost to a command<br/>
- Usage: `[p]addcost [command=] [cost=0] [duration=3600] [level=all] [prompt=notify] [modifier=static] [value=0.0]`
- Restricted to: `ADMIN`
- Checks: `server_only`
# [p]banksetrole
Set the balance of all user accounts that have a specific role<br/>
Putting + or - signs before the amount will add/remove currency on the user's bank account instead.<br/>
Examples:<br/>
- `[p]banksetrole @everyone 420` - Sets everyones balance to 420<br/>
- `[p]banksetrole @role +69` - Increases balance by 69 for everyone with the role<br/>
- `[p]banksetrole @role -42` - Decreases balance by 42 for everyone with the role<br/>
**Arguments**<br/>
- `<role>` The role to set the currency of for each user that has it.<br/>
- `<creds>` The amount of currency to set their balance to.<br/>
- Usage: `[p]banksetrole <role> <creds>`
- Restricted to: `ADMIN`
- Checks: `is_owner_if_bank_global`