Update README
This commit is contained in:
parent
7bf6435638
commit
2b12c99813
17
README.md
17
README.md
@ -71,7 +71,7 @@ Tutorial/onboarding system:
|
|||||||
|
|
||||||
### Player Progression
|
### Player Progression
|
||||||
|
|
||||||
#### Stats System (`GameTypes.fs:41-55`)
|
#### Stats System
|
||||||
Four core attributes with time-based decay:
|
Four core attributes with time-based decay:
|
||||||
- **Strength**: Combat effectiveness
|
- **Strength**: Combat effectiveness
|
||||||
- **Focus**: Precision and accuracy
|
- **Focus**: Precision and accuracy
|
||||||
@ -85,7 +85,7 @@ Each stat features:
|
|||||||
|
|
||||||
## Discord Integration
|
## Discord Integration
|
||||||
|
|
||||||
### Multi-Bot Architecture (`Bot.fs:53-59`)
|
### Multi-Bot Architecture
|
||||||
The system uses multiple specialized Discord bot clients:
|
The system uses multiple specialized Discord bot clients:
|
||||||
- **hackerBattleBot**: HackerBattle game interactions
|
- **hackerBattleBot**: HackerBattle game interactions
|
||||||
- **storeBot**: Store transactions and interactions
|
- **storeBot**: Store transactions and interactions
|
||||||
@ -102,10 +102,10 @@ The system uses multiple specialized Discord bot clients:
|
|||||||
|
|
||||||
## Database Design
|
## Database Design
|
||||||
|
|
||||||
### PostgreSQL Integration (`DbService.fs`)
|
### PostgreSQL Integration
|
||||||
Type-safe database operations using Npgsql.FSharp:
|
Type-safe database operations using Npgsql.FSharp:
|
||||||
|
|
||||||
- **User table**: Discord IDs, display names, GBT balances, wallet addresses
|
- **User table**: Discord IDs, display names, GBT balances
|
||||||
- **Item system**: Database-driven item definitions with custom composite types
|
- **Item system**: Database-driven item definitions with custom composite types
|
||||||
- **Event tracking**: Player actions, cooldowns, game history with proper typing
|
- **Event tracking**: Player actions, cooldowns, game history with proper typing
|
||||||
- **Custom types**: `StatMod` composite type for database item modifiers
|
- **Custom types**: `StatMod` composite type for database item modifiers
|
||||||
@ -119,15 +119,6 @@ Type-safe database operations using Npgsql.FSharp:
|
|||||||
- **API Key Authentication**: `X-API-Key` header validation
|
- **API Key Authentication**: `X-API-Key` header validation
|
||||||
- **Error Handling**: Comprehensive error responses and logging
|
- **Error Handling**: Comprehensive error responses and logging
|
||||||
|
|
||||||
## Player Economy
|
|
||||||
|
|
||||||
The game features a balanced virtual economy:
|
|
||||||
- **GBT Currency**: Primary medium of exchange earned through gameplay
|
|
||||||
- **Fixed Pricing**: Items have set buy/sell prices (no dynamic market)
|
|
||||||
- **Cooldown Systems**: Rate limiting prevents exploitation
|
|
||||||
- **Risk/Reward Balance**: Thief game risk vs potential reward
|
|
||||||
- **Player Progression**: Long-term engagement through stat decay requiring active play
|
|
||||||
|
|
||||||
## Development Setup
|
## Development Setup
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
Loading…
x
Reference in New Issue
Block a user