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.

Bank

This is the cog guide for the bank 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 bank

Usage

This cog manages the bank. It won’t be used often by users but this is what makes any interaction with the money possible.

You will be able to switch between a global and a server- wide bank and choose the bank/currency name.

Commands

bankset

Note

This command is locked to the server owner.

Syntax

[p]bankset

Description

Base command for configuring bank settings.

bankset toggleglobal

Note

This command is locked to the bot owner.

Syntax

[p]bankset toggleglobal [confirm=False]

Description

Makes the bank global instead of server-wide. If it is already global, the command will switch it back to the server-wide bank.

Warning

Using this command will reset all accounts.

Arguments

  • [confirm=False]: Put yes to confirm.

bankset creditsname

Note

This command is locked to the bot owner. However, if the bank is server-wide, the server owner or an administrator can use this command.

Syntax

[p]bankset creditsname <name>

Description

Change the credits name of the bank. It is credits by default.

For example, if you switch it to dollars, the payday command will show this:

Here, take some dollars. Enjoy! (+120 dollars!)

You currently have 220 dollars.

Arguments

  • <name>: The new credits name.

bankset bankname

Note

This command is locked to the bot owner. However, if the bank is server-wide, the server owner or an administrator can use this command.

Syntax

[p]bankset bankname <name>

Description

Set bank’s name.

Arguments

  • <name>: The new bank’s name.

bankset maxbal

Note

This command is locked to the bot owner. However, if the bank is server-wide, the server owner or an administrator can use this command.

Syntax

[p]bankset maxbal <amount>

Description

Defines the maximum amount of money a user can have with the bot.

If an user reaches this limit, he will be unable to gain more money.

Arguments

  • <amount>: The maximum amount of money for users.

bankset showsettings

Note

This command is locked to the bot owner. However, if the bank is server-wide, the server owner or an administrator can use this command.

Syntax

[p]bankset showsettings

Description

Shows the current settings of your bank.

This will display the following information:

  • Name of the bank

  • Scope of the bank (global or per server)

  • Currency name

  • Default balance

  • Maximum allowed balance