# How to Use?

{% hint style="success" %}
Check out this twitter thread for a summary of all features: <https://x.com/steakers_xyz/status/1961327248784437469>
{% endhint %}

## Step-by-Step Setup (for project servers)

> This guide walks you from a fresh install to a fully-running economy with rewards, UIs, games, and ops tools.\
> It’s written for **server owners/admins**.
>
> ***Note: This is just one of many ways of utilizing this app.***

***

### 1) Configure your currency (name & emoji)

1. Run:

```bash
/currency-config [emoji] [name]
```

* Emoji must be from your server; name must be 2–10 chars.

2. (Optional) Seed test balances and review top users:

```bash
/add-balance <amount> <user> [balance_type] [private_message]
/balance [user] [private_message]
/leaderboard [balance_type] [page]
```

* **Checking** = where earnings land
* **Cash** = spendable wallet

3. (Optional) **Migrate** balances from another system:

```bash
/upload-csv <csv_file>
```

* Requires strict 3-column format: `User ID, Username, Balance`

***

### 2) Place the core economy UIs

#### 2A) Tax Center

1. Place the UI in your **#🤖┃tax-center** channel:

```bash
/tax-center ui <channel> [tax_center_ui_image_url] [tax_center_ui_embed_text]
```

2. Configure taxes and minimum withdraw:

```bash
/tax-center add-tax <tax_role> <tax_rate>
/tax-center remove-tax <tax_role>
/tax-center minimum-withdraw [balance]
```

#### 2B) Points Parlor (Shop + Lottery)

Create the UI in **#🤖┃shop-lottery**:

```bash
/points-parlor-ui
```

**Shop (roles/items):**

```bash
/shop add-item <item_name> <item_price> <role_to_give> [role_to_have] [item_description] [item_stock] [item_image_url]
/shop item-info <item_name>
/shop edit-item <item_name> [...]
/shop delete-item <item_name>
/shop all-items
```

**Lottery:**

```bash
/lottery create <name> <desc> <ticket_price> <duration_hours> <max_tickets_per_user> [total_winners] [image_url]
/lottery info <name>
/lottery edit <name> [...]
/lottery delete <name>
```

#### 2C) Tasks

1. Place the UI in **#🤖┃tasks**:

```bash
/tasks ui <channel> [task_ui_image_url] [task_ui_embed_text]
```

2. Create/manage tasks:

```bash
/tasks add <text|image> <task_name> <task_description> <task_reward> [allowed_role] [max_approvals]
/tasks edit <task_name> [...]
/tasks delete <task_name>
/tasks view-all
/tasks review [task_name] [user_name]
```

* Users submit via the UI or:

```bash
/submit-task <task_name> <image>
```

***

### 3) Turn on earning streams (engagement & growth)

#### 3A) Reaction Tracking

```bash
/reaction add-channel <channel>
/reaction reward-per-reaction <amount>
/reaction days-ago-limit <days>
/reaction view-config
```

#### 3B) Chat Tracking

```bash
/chat add-channel <channel>
/chat reward-per-message <amount>
/chat cooldown-per-user <seconds>
/chat minimum-characters <number>
/chat view-config
```

#### 3C) Invite Tracking

```bash
/invite-config set-reward <amount>
/invite-config set-required-role <role>
/invite-config set-minimum-stay-days <days>
/invite-config remove-required-role
/invite-config view
```

* Members check stats:

```bash
/invites
```

***

### 4) Add recurring Income (role-based salaries)

1. Configure role incomes:

```bash
/config-income add <role> <reward_amount> <cooldown_per_user_days>
/config-income remove <role>
```

2. Members claim with:

```bash
/income claim
```

***

### 5) Let users spend (Shop/Lottery + Cash)

* Users **earn into Checking** → withdraw to **Cash** (at the Tax Center) before buying shop items or lottery tickets.

***

### 6) Optional fun & competition

**Mini-games:**

```bash
/flip <bet>
/slots <bet>
/roll <guess 1-6> <bet>
/rps <choice> <bet>
/guess <guess 1-10> <bet>
```

**Rumble Royale (admin-only):**

```bash
/rumble-start <reward> <max_players> <join_time>
```

**Looting:**

```bash
/loot-config [loot_amount_percentage] [bail_amount_percentage]
/loot @user
/buy-shield <qty>
/shield-threshold <amount>
/shield-info
```

***

### 7) Boost socials with Twitter/X Raids

```bash
/twitter-raid <tweet_url> <ping_role> [duration_in_hours] [channel] [custom_message]
```

***

### 8) Community ops (quality-of-life modules)

**Auto Role Claiming:**

```bash
/claim-role ui <channel> [embed_text] [image_url]
/claim-role add <role> <description>
/claim-role remove <role_name>
/claim-role view
```

**Tickets:**

```bash
/tickets manager-role <role>
/tickets transcript-channel <channel>
/tickets ui <channel> [tickets_ui_image_url] [tickets_ui_embed_text]
```

**Server Verification:**

```bash
/verification-role [role]
/verification-setup <channel> [embed_text] [image_url]
```

**Embed Creator:**

```bash
/create-embed
```

**Custom Data Collection:**

```bash
/custom-data enable "<prompt>"
/custom-data view
/custom-data disable
/custom-data check <user>
/custom-data reset-all
/custom-data download-csv
/submit-info
```

**Reports & Exports:**

```bash
/download-csv <data_type>
/get-all-balance
```

***

### 9) Best-practice rollout checklist

* [ ] Currency set (`/currency-config`)
* [ ] Tax Center UI placed; tax roles/rates set
* [ ] Points Parlor UI live; shop item and/or lottery created
* [ ] Tasks UI live; starter tasks added
* [ ] Reaction/Chat/Invite trackers configured
* [ ] Role incomes configured; announce `/income claim`
* [ ] Optional: Mini-games & Looting enabled
* [ ] Optional: Twitter raid template ready
* [ ] Ops: Tickets UI placed; Auto-Role Claiming & Verification set
* [ ] Back-office: enable CSV exports/imports and set staff expectations

***

### 10) Quick command crib sheet

```
# Currency
/currency-config [emoji] [name]

# Economy basics
/add-balance …   /balance …   /leaderboard …

# Tax Center
/tax-center ui <channel> …
/tax-center add-tax <role> <rate>
/tax-center minimum-withdraw [balance]

# Shop & Lottery
/points-parlor-ui
/shop add-item …   /shop all-items
/lottery create …  /lottery info …

# Tasks
/tasks ui <channel> …
/tasks add <text|image> …

# Trackers
/reaction add-channel <channel>   /reaction view-config
/chat add-channel <channel>       /chat view-config
/invite-config set-reward <amt>   /invites

# Income
/config-income add <role> <reward> <cooldown_days>
/income claim

# Games & Loot
/flip /slots /roll /rps /guess
/rumble-start …
/loot-config …   /loot @user   /buy-shield <qty>

# Social
/twitter-raid <tweet_url> <ping_role> [duration] [channel] [msg]

# Community ops
/claim-role ui <channel> …   /tickets ui <channel> …
/verification-setup <channel> …

# Data & reports
/custom-data enable "Prompt"   /submit-info
/download-csv <type>           /upload-csv <file>
```
