Skip to content

Commit 661df7f

Browse files
committed
readme update
1 parent eb2b0e7 commit 661df7f

1 file changed

Lines changed: 38 additions & 18 deletions

File tree

README.md

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,27 @@ A Discord bot for tabletop gaming enthusiasts, featuring dice rolling and item t
2626

2727
### 🏦 Currency Bank
2828

29-
- **Deposit currency**: `/bank deposit currency:gold amount:50` (supports platinum, gold, silver, electrum, copper)
30-
- **Withdraw currency**: `/bank withdraw currency:silver amount:10` (with balance validation)
31-
- **Check balance**: `/bank balance` (shows all currencies with gold value conversion)
32-
- **Convert currency**: `/bank convert from:gold to:silver amount:10` (with configurable fees)
33-
- **Set conversion fees**: `/bank setfee rate:0.05` (5% fee, requires MANAGE_CHANNELS)
34-
- **View fee settings**: `/bank fees` (current rates and examples)
35-
- **Clear bank**: `/bank clear` (requires MANAGE_CHANNELS permission)
36-
- **View audit log**: `/bank audit limit:30` (complete transaction history)
29+
#### D&D Currency System
30+
- **Deposit currency**: `/bank dnd deposit currency:gold amount:50` (supports platinum, gold, silver, electrum, copper)
31+
- **Withdraw currency**: `/bank dnd withdraw currency:silver amount:10` (with balance validation)
32+
- **Check balance**: `/bank dnd balance` (shows all currencies with gold value conversion)
33+
- **Convert currency**: `/bank dnd convert from:gold to:silver amount:10` (with configurable fees)
34+
- **Set conversion fees**: `/bank dnd setfee rate:0.05` (5% fee, requires MANAGE_CHANNELS)
35+
- **View fee settings**: `/bank dnd fees` (current rates and examples)
36+
- **Clear bank**: `/bank dnd clear` (requires MANAGE_CHANNELS permission)
37+
- **View audit log**: `/bank dnd audit limit:30` (complete transaction history)
38+
39+
#### Decimal Currency System
40+
- **Deposit currency**: `/bank decimal deposit amount:50.25` (supports decimal amounts)
41+
- **Withdraw currency**: `/bank decimal withdraw amount:25.50` (with balance validation)
42+
- **Check balance**: `/bank decimal balance` (shows current decimal balance)
43+
- **Clear bank**: `/bank decimal clear` (requires MANAGE_CHANNELS permission)
44+
- **View audit log**: `/bank decimal audit limit:30` (complete transaction history)
45+
46+
#### Features
3747
- Per-channel currency management with automatic cleanup
38-
- Configurable conversion fees (default 10%, 0-100% range)
39-
- D&D standard conversion rates with fee deduction
48+
- Multiple currency systems (D&D standard and decimal)
49+
- Configurable conversion fees for D&D system (default 10%, 0-100% range)
4050
- Built-in currency validation and abbreviation display
4151
- Complete audit trail of all transactions and fee changes
4252

@@ -118,15 +128,25 @@ npm test
118128

119129
### Currency Bank
120130

131+
#### D&D Currency System
121132
```
122-
/bank deposit currency:gold amount:100
123-
/bank withdraw currency:silver amount:25
124-
/bank balance # View all currency balances with gold conversion
125-
/bank convert from:gold to:silver amount:10 # Convert with fees
126-
/bank setfee rate:0.05 # Set 5% conversion fee (admin only)
127-
/bank fees # View current fee settings and examples
128-
/bank clear # Requires MANAGE_CHANNELS permission
129-
/bank audit limit:15 # View recent 15 transactions
133+
/bank dnd deposit currency:gold amount:100
134+
/bank dnd withdraw currency:silver amount:25
135+
/bank dnd balance # View all currency balances with gold conversion
136+
/bank dnd convert from:gold to:silver amount:10 # Convert with fees
137+
/bank dnd setfee rate:0.05 # Set 5% conversion fee (admin only)
138+
/bank dnd fees # View current fee settings and examples
139+
/bank dnd clear # Requires MANAGE_CHANNELS permission
140+
/bank dnd audit limit:15 # View recent 15 transactions
141+
```
142+
143+
#### Decimal Currency System
144+
```
145+
/bank decimal deposit amount:150.75
146+
/bank decimal withdraw amount:25.50
147+
/bank decimal balance # View current decimal balance
148+
/bank decimal clear # Requires MANAGE_CHANNELS permission
149+
/bank decimal audit limit:15 # View recent 15 transactions
130150
```
131151

132152
## Technical Details

0 commit comments

Comments
 (0)