Files
rr3-apk/QUICK_REFERENCE.md

335 lines
6.0 KiB
Markdown

# 🎮 RR3 Community Server - Quick Reference
## 🚀 Quick Start Commands
### Start Server
```bash
cd E:\rr3\RR3CommunityServer\RR3CommunityServer
dotnet run
```
Server runs at: **http://localhost:5001**
Admin panel: **http://localhost:5001/admin**
### Build Modified APK
```powershell
cd E:\rr3\rr3-apk
.\RR3-Server-Browser-Installer.ps1 -ApkPath "realracing3.apk"
```
### Install APK on Device
```bash
adb install realracing3-community.apk
```
### Open Server Browser
```bash
adb shell am start -n com.ea.games.r3_row/com.community.CommunityServersActivity
```
---
## 📁 Repository URLs
- **Server**: https://github.com/ssfdre38/rr3-server
- **APK**: https://github.com/ssfdre38/rr3-apk
---
## 🎯 Key Features
### rr3-server
- ✅ Web admin panel
- ✅ Daily rewards (50 Gold + $5K)
- ✅ Time trials
- ✅ Car ownership (5 cars)
- ✅ Upgrade system (5 types)
- ✅ Career progression
- ✅ Level/XP system
### rr3-apk
- ✅ Server browser UI
- ✅ Unlimited server profiles
- ✅ One-click switching
- ✅ Online/offline status
- ✅ No rebuilds needed
---
## 📊 Economy Cheat Sheet
### Starting Resources
- Level: 1
- Gold: 0
- Cash: $50,000
### Daily Income (~350 Gold + ~$70K)
- Daily Reward: 50 Gold + $5,000
- Time Trials: 150 Gold + $35,000
- Career Events: 150 Gold + $30,000
- Level Ups: 10 Gold + $5,000 per level
### Car Prices
- Class C: $25,000 (Nissan Silvia)
- Class B: 150 Gold or $85,000 (Ford Focus)
- Class A: 350 Gold (Porsche 911)
- Class S: 750 Gold (Ferrari 488)
- Class R: 1,500 Gold (McLaren P1)
### Upgrades (per car)
- Engine: $5,000 (+3 PR)
- Tires: $3,000 (+2 PR)
- Suspension: $4,000 (+2 PR)
- Brakes: $3,500 (+2 PR)
- Drivetrain: $4,500 (+3 PR)
**Total**: $20,000 for +12 PR
---
## 🔌 API Endpoints
### Director
```
GET /director
```
### Authentication
```
POST /synergy/account/register
POST /synergy/account/login
GET /synergy/account/info/{id}
```
### Rewards
```
POST /synergy/rewards/daily/{id}
POST /synergy/rewards/gold/purchase
GET /synergy/rewards/timetrials
POST /synergy/rewards/timetrials/{id}/submit
```
### Progression
```
GET /synergy/progression/player/{id}
POST /synergy/progression/player/{id}/update
POST /synergy/progression/car/purchase
POST /synergy/progression/car/upgrade
POST /synergy/progression/career/complete
```
### Commerce
```
GET /synergy/commerce/catalog
POST /synergy/commerce/purchase
```
Test at: **http://localhost:5001/swagger**
---
## 🎨 Web Admin Pages
- `/admin` - Dashboard
- `/users` - User management
- `/catalog` - Store items
- `/sessions` - Active connections
- `/purchases` - Transaction history
- `/rewards` - Daily rewards & time trials
- `/settings` - Configuration
---
## 📱 Server Browser UI Flow
1. Open Server Browser
2. Tap **"+ Add New Server"**
3. Enter Name + URL
4. Tap **"Test Connection"**
5. Tap **"Save"**
6. Tap **"Connect"**
7. Restart game
8. Play!
---
## 🔧 Development
### Update Server Code
```bash
cd E:\rr3\RR3CommunityServer\RR3CommunityServer
# Make changes
dotnet build
dotnet run
```
### Push Changes
```bash
git add .
git commit -m "Your message"
git push
```
### Update Database
```bash
# Delete existing DB to recreate with seed data
rm -f rr3.db
dotnet run
```
---
## 🐛 Troubleshooting
### Server won't start
```bash
# Check port 5001 is free
netstat -ano | findstr :5001
# Kill process if needed
taskkill /PID <pid> /F
```
### APK won't install
```bash
# Uninstall original RR3
adb uninstall com.ea.games.r3_row
# Try again
adb install realracing3-community.apk
```
### Game can't connect
- Check server URL is correct
- Verify server is running
- Test with curl:
```bash
curl http://localhost:5001/director
```
- Check firewall settings
---
## 📚 Documentation
### Main Guides
- `PROJECT_COMPLETE_SUMMARY.md` - Overview
- `rr3-server/PROGRESSION_SYSTEM.md` - Game systems
- `rr3-apk/docs/SERVER_BROWSER_GUIDE.md` - User guide
### Technical Docs
- `rr3-server/WEB_PANEL_GUIDE.md` - Admin panel
- `rr3-apk/docs/SMALI_REFERENCE.md` - APK modding
- `rr3-apk/APK_MODIFICATION_GUIDE.md` - Details
---
## 💡 Quick Tips
### For Server Owners
1. Configure daily rewards in admin panel
2. Create time trial events
3. Add more cars to catalog
4. Share server URL with players
5. Monitor sessions page
### For Players
1. Claim daily rewards every day
2. Complete time trials for gold
3. Save gold for higher-class cars
4. Upgrade cars with cash
5. Complete career for XP
### For Developers
1. Test with Swagger UI
2. Check SQLite database with DB Browser
3. Monitor server logs
4. Use logcat for APK debugging
5. Read documentation thoroughly
---
## 🎖️ Seeded Content
### Cars (5)
- Nissan Silvia Spec-R (C)
- Ford Focus RS (B)
- Porsche 911 GT3 RS (A)
- Ferrari 488 GTB (S)
- McLaren P1 GTR (R)
### Upgrades
- 5 types for Nissan Silvia
### Time Trials (2)
- Silverstone National
- Dubai Autodrome
### Gold Packages (4)
- 100 Gold (FREE)
- 500 Gold (FREE)
- 1,000 Gold (FREE)
- 5,000 Gold (FREE)
---
## ⚙️ Configuration
### Server URL Format
```
http://localhost:5001 # Local
http://192.168.1.100:5001 # LAN
https://rr3.example.com # Public
```
### Database Location
```
RR3CommunityServer/RR3CommunityServer/rr3.db
```
### APK Assets
```
rr3-apk/assets/
├── community_servers_list.html
└── community_server_edit.html
```
---
## 🎯 Success Checklist
✅ Server builds and runs
✅ Admin panel loads
✅ API responds to /director
✅ APK mod script works
✅ Server browser UI shows
✅ Can add servers
✅ Can connect to server
✅ Game loads and plays
✅ Daily rewards work
✅ Can purchase cars
✅ Can upgrade cars
✅ Career events work
---
## 🚀 Share Your Server
Template for players:
```
🏎️ RR3 Community Server
Server Name: [Your Name]
Server URL: http://your-server.com:5001
Instructions:
1. Install modded APK
2. Open Server Browser
3. Add server with URL above
4. Connect and restart game
5. Enjoy!
```
---
**Everything you need in one place!** 📋
Quick reference for daily use of your RR3 Community Server ecosystem.