Skip to main content

Welcome to '🧭 Compass' !

Let me guide you through the Sunrise server documentation, friend!

Sunrise logo

📝 About​

This is the documentation for the Sunrise - osu! server (codebase, not deployment), written fully from ground up in C#.

This documentation is built using Docusaurus, and as you noticed, named as 'Compass'.
We chose this name because it represents guidance and direction, which is what this documentation aims to provide.

✅ What you will find here​

  • Getting Started: Learn how to set up and run the Sunrise server.
  • Contributing: Guidelines for contributing to the Sunrise Community projects.
  • FAQ: Frequently Asked Questions about the server and setup process.

❌ What you won't find here​

  • Game Mechanics Explanation: This documentation does not cover osu! game mechanics. For that, refer to the osu! wiki.

    warning

    You are expected to have basic knowledge of osu! and its mechanics, as this documentation does not cover those aspects.

  • How to change thing X to Y: This documentation does not provide step-by-step guides for changing specific features.

  • Server Hosting: This documentation does not cover how to host the server on your own infrastructure. At least for now.

❤️ Final Notes​

This documentation is written after multiple instances of confusion and questions from the community.

We hope it serves as a comprehensive guide for both new and experienced developers.