Sparkle Server Documentation Overview¶
Welcome to the Sparkle server documentation! Sparkle is an open-source, community-driven fan server project for KRFN.
This section provides key information regarding server policies, user guides, in-game testing commands, technical limitations, and release history.
Documentation Index¶
Below is an overview of all documents in this section:
| Document | Summary & Purpose |
|---|---|
| Frequently Asked Questions (FAQ) | Answers common questions about project history, server progress, save data preservation, and contribution guidelines. |
| Cheat Commands | Detailed guide and reference table for in-game debug commands (item, character, and currency generation). |
| Server Limitations | Outline of current server constraints, unimplemented features (e.g., Ability Tree scrolls, room mechanics), and known bugs. |
| Terms of Service | Rules and policies for using the Sparkle server, user responsibilities, account limits, and disclaimers. |
| Changelog | Full update history detailing server version releases, feature implementations, and bug fixes. |
Overview & Quick Links¶
- Connecting to Sparkle: To connect to a Sparkle server, follow the step-by-step guides in the Player Guides.
- Self-Hosting & Development: Interested in running your own server instance or contributing code? Check out the Self-Hosting Guide and Developer Overview.
- Source Code: The server source code is hosted on GitLab at kirafan/sparkle/server.
Important
Please review the Terms of Service and Server Limitations before joining community servers to understand current server behavior and user guidelines.