Developer Guides Overview¶
Development and analysis documentation for Sparkle, compiling technical specifications, file formats, and deployment guides.
Getting Started¶
If you are a new developer or researcher looking to explore the project, we recommend following these steps:
- Understand Client Internals: Read the Client File Structure and API Encryption to understand how the game client stores local data and communicates securely with the server.
- Learn to Set Up a Local Test Environment: Read the Self-Hosting Overview to deploy your own local emulation server instance.
- Explore Detailed Specifications: Use the directory below to dive into specific topics like asset bundle formats, encryption keys, and database structures.
Directory of Developer Documentation¶
The table below summarizes all developer-focused documentation available in this repository.
Specifications (Specs)¶
Detailed breakdowns of internal client behaviors, network security, and local file storage.
| Component | Topic | Description | Link |
|---|---|---|---|
| API | HTTP Headers | Technical definitions of mandatory request and response headers. | View Headers |
| API | Payload Encryption | Description of the AES cryptographic flow used to secure API payloads. | View Encryption |
| Assets | AssetBundles | Documentation of the game's Unity AssetBundle formats and asset retrieval. | View AssetBundles |
| Assets | Asset Encryption | Detailed explanation of how game assets are encrypted and decrypted. | View Encryption |
| Client | Endpoints | Default hardcoded server endpoints and hostnames within the client. | View Endpoints |
| Client | File Structure | Essential client files, local save locations, and system database storage. | View File Structure |
| Client | Database | Structure of the local SQLite databases used to cache master game data. | View Database |
Self-Hosting¶
Guides for setting up, configuring, and deploying your own emulated server ecosystem.
| Topic | Description | Link |
|---|---|---|
| Architecture Overview | System flow and breakdown of individual services (Go API, Schedule Mock, Go Web Admin). | View Overview |
| Setup & Deployment | Step-by-step instructions for running the server locally via Docker Compose or SQLite. | View Setup Guide |