120 lines
3.8 KiB
Markdown
120 lines
3.8 KiB
Markdown
# City
|
|
|
|
A comprehensive city simulation system with various activities (currently only contains crime module). Features a crime system for earning credits through virtual crimes with different risk levels, cooldowns, rewards, jail system, jail breaks, dynamic events, and custom scenarios.
|
|
|
|
## Features
|
|
|
|
- 🦹♂️ Multiple crime types with varying risk levels
|
|
- 🏴☠️ Black Market shop for special items and perks
|
|
- 🎒 Personal inventory system
|
|
- ⛓️ Jail system with bail and jailbreak mechanics
|
|
- 📊 Detailed statistics and leaderboards
|
|
- 💰 Dynamic reward system
|
|
- ⚖️ Risk vs. reward gameplay
|
|
- 🎯 Target other users for crimes
|
|
- 🎲 Custom random scenarios with server-specific events
|
|
|
|
- 🎮 **Button/Dropdown-Based Interface**
|
|
- Modern, intuitive button controls
|
|
- Color-coded risk levels
|
|
- Dynamic button states based on user status
|
|
- Clean, organized menu system
|
|
|
|
- 📊 **Statistics & Leaderboards**
|
|
- Track successful and failed crimes
|
|
- Monitor lifetime earnings and largest heists
|
|
- View server-wide crime leaderboards
|
|
- Personal criminal status tracking
|
|
|
|
## Installation
|
|
|
|
1. Make sure you have Red-DiscordBot V3 installed
|
|
2. Add this repository: `[p]repo add CalaMari-Cogs https://github.com/CalaMariGold/CalaMari-Cogs`
|
|
3. Install the cog: `[p]cog install CalaMari-Cogs city`
|
|
|
|
## Setup
|
|
|
|
1. Load the cog: `[p]load city`
|
|
2. Make sure the bot has required permissions:
|
|
- Manage Messages (for button interactions)
|
|
- Send Messages
|
|
- Embed Links
|
|
- Add Reactions
|
|
3. Register your bank if not already done: `[p]bank register`
|
|
4. Customize settings as desired using the `[p]crimeset` commands
|
|
|
|
## Donate
|
|
|
|
If you enjoy using this cog, you can support my work:
|
|
|
|
[](https://ko-fi.com/calamarigold)
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have suggestions, please open an issue on the GitHub repository.
|
|
|
|
## Usage
|
|
|
|
### Crime Types
|
|
|
|
#### 🧤 Pickpocket
|
|
- Low risk, targeted crime
|
|
- Steal percentage of target's balance
|
|
- Quick cooldown
|
|
- Short jail time if caught
|
|
|
|
#### 🔪 Mugging
|
|
- Medium risk, targeted crime
|
|
- Steal percentage of target's balance
|
|
- Medium cooldown
|
|
- Moderate jail time
|
|
|
|
#### 🏪 Store Robbery
|
|
- Medium risk, non-targeted
|
|
- Fixed reward range
|
|
- Medium cooldown
|
|
- Moderate jail time
|
|
|
|
#### 🏛️ Bank Heist
|
|
- High risk, non-targeted
|
|
- Highest potential rewards
|
|
- Long cooldown
|
|
- Longest jail time
|
|
|
|
#### 🎲 Random Crime
|
|
- Random risk level
|
|
- Dynamic scenarios (both default and custom)
|
|
- Varying rewards and penalties
|
|
- Unique events and outcomes
|
|
- Server admins can create custom scenarios
|
|
|
|
### Commands
|
|
|
|
**User Commands:**
|
|
- `[p]crime` - Open the main crime menu with all available actions
|
|
- `commit` - Choose and commit a crime
|
|
- `status` - View your criminal status and stats
|
|
- `bail` - Pay to get out of jail early
|
|
- `jailbreak` - Attempt to escape from jail
|
|
- `leaderboard` - View the server's crime leaderboard
|
|
|
|
**Admin Commands:**
|
|
- `[p]crimeset` - Configure crime settings
|
|
- `success_rate <crime_type> <rate>` - Set success rate (0.0 to 1.0)
|
|
- `reward <crime_type> <min> <max>` - Set reward range
|
|
- `cooldown <crime_type> <seconds>` - Set cooldown duration
|
|
- `jailtime <crime_type> <seconds>` - Set jail time duration
|
|
- `fine <crime_type> <multiplier>` - Set fine multiplier
|
|
- `reload_defaults` - Reset to default settings
|
|
- `scenarios` - Manage custom random scenarios:
|
|
- `add` - Create a new custom scenario
|
|
- `list` - View all custom scenarios
|
|
- `remove <name>` - Remove a custom scenario
|
|
- `global` - Configure global settings:
|
|
- `bailcost <multiplier>` - Set bail cost multiplier
|
|
- `togglebail <enabled>` - Enable/disable bail system
|
|
- `view` - View all current settings
|
|
|
|
**Owner Commands:**
|
|
- `[p]wipecitydata <user>` - Wipe a user's city data
|
|
- `[p]wipecityallusers` - Wipe ALL city data (requires confirmation)
|