System Requirements Document (SRD)

Project Name: golden-casino

1. Introduction

The golden-casino project is a virtual gambling platform designed exclusively for the DonutSMP Minecraft community. It uses DonutSMP coins (a virtual currency) for all transactions, ensuring no real money is involved. The platform will feature a variety of engaging games, immersive animations, and personalized elements like Minecraft skin integration to create a unique and addictive user experience.

This document outlines the system requirements for the development of golden-casino, ensuring alignment with Xavier Moore's vision for a sleek, interactive, and user-focused casino platform.

2. System Overview

The golden-casino platform will serve as a virtual casino for the DonutSMP community, offering a range of games and features designed to entertain and retain users. Key highlights include:

• Minecraft Integration: Users log in with their Minecraft credentials, and their in-game skin's head is dynamically displayed on the site.
• Virtual Currency: Transactions are conducted using DonutSMP coins, with deposits handled via /pay xavrave in Minecraft.
• Games: A variety of games, including Mines, Blackjack, Crash, HiLo, Cross, Plinko, Keno, Tower, and a daily spin feature.
• Engaging Design: A dark casino theme with green/blue accents, impactful typography, glow effects, and animations for every interaction.
• Admin Controls: Tools for managing deposits, site settings, and active sessions.
• Retention Features: Referral codes, settings modal, and sound effects to enhance user engagement.

The platform will prioritize user immersion, with smooth animations, dynamic sound effects, and a design that encourages users to stay and play.

3. Functional Requirements

• As a User, I should be able to log in using my Minecraft credentials.
• As a User, I should see my Minecraft skin's head displayed dynamically on the website.
• As a User, I should start with a balance of 0 DonutSMP coins.
• As a User, I should be able to deposit DonutSMP coins via /pay xavrave.
• As a User, I should be able to play the following games:
  • Mines
  • Blackjack
  • Crash
  • HiLo
  • Cross
  • Plinko
  • Keno
  • Tower
  • Daily Spin
  • Crossy-style game
• As a User, I should experience animations for every interaction (e.g., button clicks, game events, page transitions).
• As a User, I should hear sound effects for wins, losses, clicks, and crashes.
• As a User, I should be able to view my game history.
• As an Admin, I should be able to manage deposits, site settings (open/closed), and active sessions.
• As a User, I should be able to use referral codes to invite others and earn rewards.
• As a User, I should be able to access a settings modal to adjust presets, format balances (e.g., 10K, 1M), and log out.

4. User Personas

4.1 Regular User

• Description: A Minecraft player who wants to use their DonutSMP coins to play games and win more virtual currency.
• Goals: Enjoy engaging games, earn DonutSMP coins, and personalize their experience.
• Key Features: Minecraft login, dynamic skin head display, game access, and referral rewards.

4.2 Admin

• Description: A site administrator responsible for managing the platform's operations.
• Goals: Ensure smooth operation of the site, manage deposits, and monitor active sessions.
• Key Features: Admin dashboard, deposit management, and site settings control.

5. Visuals Colors and Theme

The golden-casino will feature a dark, immersive casino vibe with a unique green/blue color palette.

• Background: #0A1A2E (Deep Navy Blue)
• Surface: #112B3C (Dark Teal)
• Text: #E8F1F8 (Soft White)
• Accent: #00FFAB (Vivid Green)
• Muted Tones: #3A4F63 (Muted Blue-Grey)

Glow effects and smooth animations will complement the color scheme, creating a polished and engaging user experience.

6. Signature Design Concept

Dynamic Minecraft Casino Hub

The homepage of golden-casino will be a Minecraft-inspired 3D casino lobby. Users will see their Minecraft skin's head prominently displayed on a glowing pedestal in the center of the screen. Surrounding the pedestal will be interactive game icons (e.g., Mines, Blackjack, Crash) that "light up" with animations when hovered over.

Key features of the design:

• Minecraft Skin Integration: The user's Minecraft head rotates slowly on the pedestal, with a subtle glow effect.
• Interactive Animations: Game icons bounce slightly when hovered over, with glowing outlines that match the green/blue theme.
• Idle Effects: If the user is idle, the screen subtly shifts colors, and the pedestal emits a soft pulsing glow.
• Sound Design: Ambient casino sounds (e.g., soft music, coin clinks) play in the background, with dynamic effects for interactions.
• Typography: Impact-style font for headings and buttons, giving a bold and commanding feel.

This design will make the website feel alive and immersive, encouraging users to explore and play.

7. Non-Functional Requirements

• The website must load within 3 seconds on a standard broadband connection.
• The platform must support at least 1,000 concurrent users.
• The system must ensure secure authentication for Minecraft login.
• All animations and sound effects must run smoothly on modern browsers.
• The platform must be mobile-responsive and accessible on both desktop and mobile devices.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Tools

• Litellm for LLM Routing
• Langchain

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

• Users must have a Minecraft account to access the platform.
• The platform will not involve real money transactions.
• Deposits are handled via /pay xavrave in Minecraft.
• The platform will favor the house in all games.
• The website must comply with US regulations for virtual gambling platforms.

10. Glossary

• DonutSMP Coins: Virtual currency used within the DonutSMP Minecraft server.
• Minecraft Skin Head: The 3D representation of a user's Minecraft avatar's head.
• House Edge: The statistical advantage the casino has over players in games.
• Referral Codes: Unique codes used to invite new users and earn rewards.
• Admin Dashboard: A control panel for managing the platform's operations.