The ultimate crypto trading game where strategy meets opportunity. Build your empire, compete with the best, and dominate the markets.
- ๐ฎ What is Roxy?
- โจ Key Features
- ๐๏ธ Architecture & Tech Stack
- ๐ฏ Game Mechanics
- ๐ฑ User Interface
- ๐ Getting Started
- ๐ Project Structure
- ๐จ Design System
- ๐ง Development
- ๐ Game Data & State Management
- ๐ญ Character System
- ๐ Achievement System
- ๐ฅ Guild System
- ๐ Trading System
- ๐ Leaderboard System
- ๐จ Visual Effects
- ๐ฑ Responsive Design
- ๐ฎ Future Features
- ๐ค Contributing
- ๐ License
Roxy is a revolutionary crypto portfolio management game that combines the excitement of cryptocurrency trading with engaging gamification elements. Players step into the shoes of legendary traders, build their crypto empires, and compete in a dynamic, real-time trading environment.
Roxy transforms traditional portfolio management into an immersive gaming experience where:
- Strategy meets opportunity in real-time crypto markets
- Competition drives excellence through global leaderboards
- Community builds strength via the guild system
- Achievement unlocks potential through badges and XP progression
- Live crypto market data integration
- Instant buy/sell execution
- Real-time portfolio value updates
- Advanced order types and market analysis
- XP System: Earn experience points through trading activities
- Level Progression: Unlock new features and capabilities
- Badge System: Collect achievements for various milestones
- Character Avatars: Choose from different trader personalities
- Global Leaderboards: Compete with traders worldwide
- Guild Leaderboards: Team-based competition
- Weekly Resets: Fresh competition cycles
- Rank Tracking: Monitor your position changes
- Guild System: Join forces with other traders
- Guild Chat: Communicate with your trading team
- Guild Map: Interactive guild territory visualization
- Team Strategies: Collaborative trading approaches
- Advanced Analytics: Detailed performance metrics
- Portfolio Visualization: Interactive charts and graphs
- Risk Assessment: Real-time risk analysis
- Diversification Tools: Smart portfolio optimization
- React 19.1.1 - Latest React with concurrent features
- TypeScript 5.9.3 - Type-safe development
- Vite 7.1.7 - Lightning-fast build tool
- Tailwind CSS 4.1.16 - Utility-first CSS framework
- Framer Motion 12.23.24 - Advanced animations
- React Icons 5.5.0 - Comprehensive icon library
- Recharts 3.3.0 - Data visualization
- PIXI.js 8.14.0 - 2D WebGL rendering
- @pixi/react 8.0.3 - React integration for PIXI
- @pixi/filter-drop-shadow 5.2.0 - Visual effects
- @pixi/filter-glow 5.2.1 - Glow effects
- Zustand 5.0.8 - Lightweight state management
- React Router DOM 7.9.4 - Client-side routing
- ESLint 9.36.0 - Code linting
- TypeScript ESLint 8.45.0 - TypeScript-specific linting
- PostCSS 8.5.6 - CSS processing
- Autoprefixer 10.4.21 - CSS vendor prefixes
- Earn XP through successful trades
- XP requirements increase with each level
- 1000 XP per level progression
- Visual progress bar with smooth animations
- Start at Level 1 with basic features
- Unlock advanced tools at higher levels
- Level-based trading limits and capabilities
- Prestige system for veteran players
- Trading Badges: First trade, profit milestones, volume achievements
- Social Badges: Guild activities, leaderboard positions
- Special Badges: Rare achievements, seasonal events
- Badge Rarity: Common, Rare, Epic, Legendary
- Real-time Pricing: Live market data integration
- Portfolio Tracking: Comprehensive holding management
- Profit/Loss Calculation: Real-time P&L updates
- Risk Assessment: Portfolio diversification metrics
- Instant Execution: Real-time buy/sell orders
- Quantity Controls: Precise amount selection
- Balance Management: Available funds tracking
- Transaction History: Complete trade log
- Hero Section: Compelling introduction with animated elements
- Feature Showcase: Key platform capabilities
- Character Introduction: Meet the trading personalities
- Call-to-Action: Clear entry points to the game
- Portfolio Overview: Total value and performance metrics
- XP Progress: Level progression visualization
- Recent Badges: Latest achievements display
- Quick Stats: Holdings count and best performers
- Navigation: Easy access to all features
- Asset Grid: Visual crypto asset cards
- Live Ticker: Scrolling price updates
- Sort Options: Filter by gainers, losers, or all
- Trading Interface: Integrated buy/sell modals
- Market Data: 24h change, volume, market cap
- Performance Charts: 7-day portfolio growth visualization
- Holdings List: Detailed asset breakdown
- P&L Analysis: Individual asset performance
- Risk Metrics: Portfolio diversification stats
- Global Rankings: Worldwide trader competition
- Guild Rankings: Team-based competition
- Reset Timer: Weekly competition cycles
- Rank Changes: Position movement tracking
- Player Stats: Personal ranking information
- Guild Discovery: Available guilds to join
- Current Guild: Active guild information
- Guild Map: Interactive territory visualization
- Guild Chat: Team communication (coming soon)
- Guild Creation: Start your own trading team
- Node.js 18+
- npm or yarn package manager
- Modern web browser with WebGL support
-
Clone the repository
git clone https://github.com/your-username/pred-man-cli.git cd pred-man-cli -
Install dependencies
npm install # or yarn install -
Start development server
npm run dev # or yarn dev -
Open in browser
http://localhost:5173
npm run build
# or
yarn buildnpm run preview
# or
yarn previewpred-man-cli/
โโโ ๐ public/ # Static assets
โ โโโ vite.svg
โโโ ๐ src/ # Source code
โ โโโ ๐ assets/ # Images and media
โ โ โโโ roxy-logo.png # Main logo
โ โ โโโ roxy.png # Main character
โ โ โโโ roxy-33.png # Character variant 1
โ โ โโโ roxy-44.png # Character variant 2
โ โ โโโ wealth.png # Hero image
โ โโโ ๐ components/ # Reusable components
โ โ โโโ BuySellModal.tsx # Trading interface
โ โ โโโ CanvasBackground.tsx # Animated background
โ โ โโโ Navbar.tsx # Navigation component
โ โโโ ๐ hooks/ # Custom React hooks
โ โโโ ๐ pages/ # Page components
โ โ โโโ Dashboard.tsx # Main dashboard
โ โ โโโ Guilds.tsx # Guild management
โ โ โโโ Landing.tsx # Landing page
โ โ โโโ Leaderboard.tsx # Rankings
โ โ โโโ Markets.tsx # Trading interface
โ โ โโโ Portfolio.tsx # Portfolio management
โ โโโ ๐ store/ # State management
โ โ โโโ gameStore.ts # Zustand store
โ โโโ ๐ utils/ # Utility functions
โ โ โโโ cn.ts # Class name utilities
โ โโโ App.tsx # Main app component
โ โโโ App.css # Global styles
โ โโโ index.css # Theme definitions
โ โโโ main.tsx # App entry point
โโโ ๐ dist/ # Build output
โโโ ๐ components.json # Component configuration
โโโ ๐ package.json # Dependencies
โโโ ๐ README.md # This file
โโโ ๐ THEME_GUIDE.md # Design system guide
โโโ ๐ tsconfig.json # TypeScript config
โโโ ๐ vite.config.ts # Vite configuration
- Primary Green:
#16A349- Main brand color - Accent Red:
#FF6B6B- Secondary accent - Background:
#0A0A0A- Dark theme base - Text:
#FFFFFF- Primary text color
- Success:
#16A349- Positive actions/values - Danger:
#FF6B6B- Negative actions/values - Warning:
#F59E0B- Caution states - Info:
#3B82F6- Informational content
- Brutal: Main heading font (bold, impactful)
- Mono Brutal: Code and data display
- System: Body text and UI elements
- Display: 4rem+ (hero text)
- Heading 1: 3rem (page titles)
- Heading 2: 2rem (section titles)
- Heading 3: 1.5rem (subsection titles)
- Body: 1rem (regular text)
- Small: 0.875rem (captions, labels)
- xs: 0.25rem (4px)
- sm: 0.5rem (8px)
- md: 1rem (16px)
- lg: 1.5rem (24px)
- xl: 2rem (32px)
- 2xl: 3rem (48px)
- 3xl: 4rem (64px)
- sm: 0.25rem (4px)
- md: 0.5rem (8px)
- lg: 0.75rem (12px)
- xl: 1rem (16px)
- 2xl: 1.5rem (24px)
- full: 9999px (circular)
- Standard Shadows: sm, md, lg, xl, 2xl
- Primary Glow:
0 0 20px rgb(22 163 73 / 0.3) - Large Glow:
0 0 40px rgb(22 163 73 / 0.4) - Glass Morphism: Backdrop blur effects
npm run lintnpx tsc --noEmit-
Feature Development
- Create feature branch from
main - Implement changes with TypeScript
- Add proper type definitions
- Include responsive design considerations
- Create feature branch from
-
Testing
- Test all user interactions
- Verify responsive behavior
- Check animation performance
- Validate state management
-
Code Review
- Ensure code follows project conventions
- Verify TypeScript types are correct
- Check for accessibility compliance
- Review performance implications
npm run build -- --analyze- Code Splitting: Route-based lazy loading
- Image Optimization: WebP format with fallbacks
- Tree Shaking: Unused code elimination
- Memoization: React.memo for expensive components
The game uses Zustand for lightweight, performant state management with the following structure:
interface Player {
name: string; // Player display name
balance: number; // Available trading funds
xp: number; // Experience points
level: number; // Current level
badges: Badge[]; // Earned achievements
avatar: string; // Selected character
}interface Holding {
symbol: string; // Asset symbol (BTC, ETH, etc.)
name: string; // Full asset name
quantity: number; // Amount held
buyPrice: number; // Purchase price
currentPrice: number; // Current market price
logo: string; // Display symbol/emoji
}interface Asset {
symbol: string; // Trading symbol
name: string; // Full name
price: number; // Current price
change24h: number; // 24h percentage change
logo: string; // Visual representation
marketCap: number; // Market capitalization
}buyAsset(symbol, amount)- Purchase crypto assetssellAsset(symbol, amount)- Sell crypto assetsupdatePortfolioValues()- Recalculate portfolio metrics
addXP(points)- Award experience pointsaddBadge(badge)- Grant achievement badges
joinGuild(guildId)- Join a trading guildleaveGuild()- Leave current guild
- Personality: Legendary trader with unmatched charisma
- Specialty: Balanced trading approach
- Avatar: Shield icon with rotating animation
- Unlock: Default character
- Personality: Strategic mastermind with lightning-fast reflexes
- Specialty: High-frequency trading
- Avatar: Lightning bolt with dynamic animation
- Unlock: Level 5
- Personality: Precision trader with unmatched accuracy
- Specialty: Long-term investment strategies
- Avatar: Target icon with scaling animation
- Unlock: Level 10
- Each character has unique trading bonuses
- Unlock new characters through level progression
- Character-specific achievements and badges
- Visual customization options
- First Trade: Complete your first transaction
- Profit Master: Achieve 100% portfolio growth
- Volume King: Trade $1M+ in total volume
- Diamond Hands: Hold an asset for 30+ days
- Day Trader: Complete 100 trades in a day
- Guild Leader: Create and lead a successful guild
- Team Player: Contribute to guild success
- Top Performer: Rank in top 10 globally
- Community Helper: Help other players
- Lucky Streak: Win 10 trades in a row
- Market Master: Predict 5 major market movements
- Risk Taker: Make high-risk, high-reward trades
- Conservative: Maintain positive P&L for 30 days
- Common (Green): Basic achievements
- Rare (Blue): Intermediate milestones
- Epic (Purple): Advanced accomplishments
- Legendary (Gold): Exceptional achievements
- Browse available guilds
- View member counts and total values
- Read guild descriptions and specialties
- Join guilds that match your trading style
- Create your own guild
- Set guild name and description
- Invite other players
- Manage guild settings
- Guild-specific leaderboards
- Team-based achievements
- Collaborative trading strategies
- Guild vs. guild competitions
- Real-time chat system (coming soon)
- Trading strategy discussions
- Market analysis sharing
- Social interaction features
- Shared Knowledge: Learn from experienced traders
- Team Bonuses: Guild-specific trading advantages
- Social Features: Connect with like-minded traders
- Competitive Edge: Team-based leaderboard rankings
- Asset Selection: Choose from available cryptocurrencies
- Quantity Input: Specify exact amounts to trade
- Price Display: Real-time market pricing
- Balance Check: Verify sufficient funds
- Confirmation: Review before executing
- Live Prices: Real-time cryptocurrency values
- 24h Changes: Percentage and absolute changes
- Market Cap: Total market capitalization
- Volume: Trading volume metrics
- Real-time Updates: Instant value recalculation
- P&L Analysis: Profit and loss tracking
- Performance Metrics: ROI and growth rates
- Risk Assessment: Portfolio diversification
- Instant Settlement: Immediate trade completion
- Price Validation: Real-time price verification
- Balance Updates: Automatic fund management
- Transaction Logging: Complete trade history
- Holding Tracking: Monitor all positions
- Average Cost: Calculate weighted buy prices
- Current Value: Real-time position valuation
- Performance Analysis: Individual asset tracking
- Worldwide Rankings: Compete with all players
- Portfolio Value: Total portfolio worth
- Profit Percentage: Performance-based ranking
- Rank Changes: Track position movements
- Team Rankings: Guild-specific competition
- Collaborative Scoring: Team performance metrics
- Guild vs. Guild: Inter-guild competitions
- Member Contributions: Individual guild rankings
- Portfolio Value: Total asset worth
- Profit Percentage: Performance ratio
- Trading Volume: Activity level
- Consistency: Stable performance over time
- Real-time: Live position updates
- Weekly Reset: Fresh competition cycles
- Historical Tracking: Long-term performance
- Achievement Recognition: Milestone celebrations
- Reset Timer: Countdown to next competition
- Rank Icons: Visual ranking indicators
- Change Tracking: Position movement arrows
- Personal Stats: Individual performance metrics
- Page Transitions: Smooth route changes
- Component Animations: Staggered element reveals
- Hover Effects: Interactive feedback
- Loading States: Engaging loading animations
- Floating Elements: Subtle background animations
- Progress Bars: Smooth XP and level progression
- Chart Animations: Data visualization transitions
- Modal Transitions: Smooth overlay animations
- Particle Systems: Dynamic background effects
- Geometric Shapes: Animated visual elements
- Color Transitions: Smooth color changes
- Performance Optimization: Efficient rendering
- Drop Shadows: Depth and dimension
- Glow Effects: Highlighting important elements
- Particle Trails: Interactive visual feedback
- Dynamic Lighting: Atmospheric effects
- Mobile Optimized: Touch-friendly interactions
- Performance Scaling: Adaptive quality settings
- Battery Conscious: Efficient animation loops
- Accessibility: Reduced motion support
- Base Styles: Mobile-optimized design
- Progressive Enhancement: Desktop improvements
- Touch Interactions: Mobile-friendly controls
- Performance Focus: Optimized for mobile devices
- Mobile: 320px - 768px
- Tablet: 768px - 1024px
- Desktop: 1024px - 1440px
- Large Desktop: 1440px+
- Mobile: Collapsible sidebar
- Desktop: Fixed sidebar navigation
- Touch: Swipe gestures for navigation
- Keyboard: Full keyboard navigation support
- Grid Systems: Responsive card layouts
- Typography: Scalable text sizing
- Spacing: Adaptive padding and margins
- Images: Responsive image sizing
- Lazy Loading: On-demand content loading
- Image Optimization: WebP with fallbacks
- Code Splitting: Route-based loading
- Caching: Efficient resource caching
- Order Types: Limit orders, stop losses
- Trading Pairs: More cryptocurrency options
- Advanced Charts: Technical analysis tools
- Trading Bots: Automated trading strategies
- Real-time Chat: Guild and global chat
- Social Trading: Copy successful traders
- Mentorship: Experienced trader guidance
- Events: Community trading events
- Quests: Daily and weekly challenges
- Tournaments: Competitive trading events
- NFT Integration: Unique character assets
- Achievement Rewards: Unlockable content
- Advanced Metrics: Detailed performance analysis
- Risk Management: Portfolio risk assessment
- Market Insights: AI-powered market analysis
- Trading Journal: Detailed trade logging
- Real-time Data: WebSocket integration
- Offline Support: Progressive Web App features
- Mobile App: Native mobile applications
- API Integration: External data sources
We welcome contributions to Roxy! Here's how you can help:
- Bug Fixes: Report and fix issues
- Feature Development: Implement new features
- Performance: Optimize existing code
- Documentation: Improve project documentation
- UI/UX: Improve user interface design
- Animations: Create engaging animations
- Graphics: Design visual elements
- Accessibility: Improve accessibility features
- Testing: Test new features and report bugs
- Feedback: Provide user experience feedback
- Documentation: Write guides and tutorials
- Translation: Help with internationalization
- TypeScript: Use strict type checking
- ESLint: Follow project linting rules
- Prettier: Maintain consistent code formatting
- Testing: Include tests for new features
type(scope): description
feat(trading): add limit order functionality
fix(ui): resolve modal positioning issue
docs(readme): update installation instructions
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
- Address review feedback
This project is licensed under the MIT License - see the LICENSE file for details.
- โ Commercial use allowed
- โ Modification allowed
- โ Distribution allowed
- โ Private use allowed
- โ No liability or warranty provided
- React - UI framework
- TypeScript - Type safety
- Vite - Build tooling
- Tailwind CSS - Styling
- Framer Motion - Animations
- PIXI.js - Graphics rendering
- Zustand - State management
- Recharts - Data visualization
- Brutalist Design - Bold, impactful aesthetics
- Gaming UI - Engaging user interfaces
- Financial Apps - Professional trading interfaces
- Modern Web Design - Contemporary design patterns
- Contributors - All code contributors
- Testers - Beta testing community
- Feedback - User suggestions and improvements
- Support - Community support and help
Join thousands of traders already building their crypto empires with Roxy!
๐ฎ Start Trading Now ๐ Report Issues ๐ฌ Join DiscussionMade with โค๏ธ by the Roxy Team | Built with React, TypeScript, and lots of โ
Last updated: December 2024