Warning

This document is for Red's development version, which can be significantly different from previous releases. If you're a regular user, you should read the Red documentation for the current stable release.

Economy

This is the cog guide for the economy cog. You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, load it by typing this:

[p]load economy

Usage

Get rich and have fun with imaginary currency!

Commands

bank

Syntax

[p]bank

Description

Base command to manage the bank.

bank balance

Syntax

[p]bank balance [user]

Description

Show the user’s account balance.

Example:
  • [p]bank balance

  • [p]bank balance @Twentysix

Arguments

  • <user> The user to check the balance of. If omitted, defaults to your own balance.

bank prune

Note

This command is locked to the admin role.

Syntax

[p]bank prune

Description

Base command for pruning bank accounts.

bank prune global

Note

This command is locked to the bot owner.

Syntax

[p]bank prune global [confirmation=False]

Description

Prune bank accounts for users who no longer share a server with the bot.

Cannot be used without a global bank. See [p]bank prune server.

Examples:
  • [p]bank prune global - Did not confirm. Shows the help message.

  • [p]bank prune global yes

Arguments

  • <confirmation> This will default to false unless specified.

bank prune server

Note

This command is locked to the server owner.

Syntax

[p]bank prune server [confirmation=False]

Tip

Aliases: bank prune guild, bank prune local

Description

Prune bank accounts for users no longer in the server.

Cannot be used with a global bank. See [p]bank prune global.

Examples:
  • [p]bank prune server - Did not confirm. Shows the help message.

  • [p]bank prune server yes

Arguments

  • <confirmation> This will default to false unless specified.

bank prune user

Syntax

[p]bank prune user <user> [confirmation=False]

Description

Delete the bank account of a specified user.

Examples:
  • [p]bank prune user @TwentySix - Did not confirm. Shows the help message.

  • [p]bank prune user @TwentySix yes

Arguments

  • <user> The user to delete the bank of. Takes mentions, names, and user ids.

  • <confirmation> This will default to false unless specified.

bank reset

Note

This command is locked to the server owner.

Syntax

[p]bank reset [confirmation=False]

Description

Delete all bank accounts.

Examples:
  • [p]bank reset - Did not confirm. Shows the help message.

  • [p]bank reset yes

Arguments

  • <confirmation> This will default to false unless specified.

bank set

Note

This command is locked to the admin role.

Syntax

[p]bank set <to> <creds>

Description

Set the balance of a user’s bank account.

Putting + or - signs before the amount will add/remove currency on the user’s bank account instead.

Examples:
  • [p]bank set @Twentysix 26 - Sets balance to 26

  • [p]bank set @Twentysix +2 - Increases balance by 2

  • [p]bank set @Twentysix -6 - Decreases balance by 6

Arguments

  • <to> The user to set the currency of.

  • <creds> The amount of currency to set their balance to.

bank transfer

Syntax

[p]bank transfer <to> <amount>

Description

Transfer currency to other users.

This will come out of your balance, so make sure you have enough.

Example:
  • [p]bank transfer @Twentysix 500

Arguments

  • <to> The user to give currency to.

  • <amount> The amount of currency to give.

economyset

Note

This command is locked to the admin role.

Syntax

[p]economyset

Description

Base command to manage Economy settings.

economyset paydayamount

Syntax

[p]economyset paydayamount <creds>

Description

Set the amount earned each payday.

Example:
  • [p]economyset paydayamount 400

Arguments

  • <creds> The new amount to give when using the payday command. Default is 120.

economyset paydaytime

Syntax

[p]economyset paydaytime <seconds>

Description

Set the cooldown for the payday command.

Example:
  • [p]economyset paydaytime 86400

Arguments

  • <seconds> The new number of seconds to wait in between uses of payday. Default is 300.

economyset registeramount

Syntax

[p]economyset registeramount <creds>

Description

Set the initial balance for new bank accounts.

Example:
  • [p]economyset registeramount 5000

Arguments

  • <creds> The new initial balance amount. Default is 0.

economyset rolepaydayamount

Syntax

[p]economyset rolepaydayamount <role> <creds>

Description

Set the amount earned each payday for a role.

Only available when not using a global bank.

Example:
  • [p]economyset rolepaydayamount @Members 400

Arguments

  • <role> The role to assign a custom payday amount to.

  • <creds> The new amount to give when using the payday command.

economyset showsettings

Syntax

[p]economyset showsettings

Description

Shows the current economy settings

economyset slotmax

Syntax

[p]economyset slotmax <bid>

Description

Set the maximum slot machine bid.

Example:
  • [p]economyset slotmax 50

Arguments

  • <bid> The new maximum bid for using the slot machine. Default is 100.

economyset slotmin

Syntax

[p]economyset slotmin <bid>

Description

Set the minimum slot machine bid.

Example:
  • [p]economyset slotmin 10

Arguments

  • <bid> The new minimum bid for using the slot machine. Default is 5.

economyset slottime

Syntax

[p]economyset slottime <seconds>

Description

Set the cooldown for the slot machine.

Example:
  • [p]economyset slottime 10

Arguments

  • <seconds> The new number of seconds to wait in between uses of the slot machine. Default is 5.

leaderboard

Syntax

[p]leaderboard [top=10] [show_global=False]

Description

Print the leaderboard.

Defaults to top 10.

Examples:
  • [p]leaderboard

  • [p]leaderboard 50 - Shows the top 50 instead of top 10.

  • [p]leaderboard 100 yes - Shows the top 100 from all servers.

Arguments

  • <top> How many positions on the leaderboard to show. Defaults to 10 if omitted.

  • <show_global> Whether to include results from all servers. This will default to false unless specified.

payday

Syntax

[p]payday

Description

Get some free currency.

The amount awarded and frequency can be configured.

payouts

Syntax

[p]payouts

Description

Show the payouts for the slot machine.

slot

Syntax

[p]slot <bid>

Description

Use the slot machine.

Example:
  • [p]slot 50

Arguments

  • <bid> The amount to bet on the slot machine. Winning payouts are higher when you bet more.