README

This repository contains the official documentation source files for LuciferCore, a high-performance, modular backend framework for .NET based on Data-Oriented Design (DOD).

[!IMPORTANT] 🌐 Live Documentation: LuciferCore Docsarrow-up-right

This is the source repository. For the framework's source code, please visit the Main Repositoryarrow-up-right.


πŸš€ About LuciferCore

LuciferCore is designed to push .NET performance to hardware limits. By utilizing Data-Oriented Design (DOD), it ensures maximum CPU Cache Locality and zero-allocation execution pathways, making it ideal for low-latency and high-throughput server-side applications.

Key Pillars:

  • Zero-Allocation: Optimized memory management using contiguous virtualized pools.

  • Cache Locality: Minimized pointer chasing to keep data in L1/L2/L3 caches.

  • Event-Driven: A high-scale asynchronous ecosystem for modern networking (TCP, UDP, SSL, WebSockets).


πŸ›  Repository Structure

The documentation is organized as follows:

  • getting-started/: Installation guides, Quick Start, and Architecture overview.

  • guides/: Deep dives into defining servers, session management, and the Manager system.

  • api-reference/: Detailed technical specifications for Attributes, Models, and Transport layers (NetCoreServer).

  • SUMMARY.md: The backbone of the GitBook sidebar navigation.


✍️ Contributing

We welcome contributions to improve the quality of our documentation! Whether it's fixing a typo, adding a code example, or improving translations.

  1. Fork the repo.

  2. Create a new Branch.

  3. Commit your changes (ensure Markdown formatting is correct).

  4. Open a Pull Request.

Refer to CONTRIBUTING.mdarrow-up-right for detailed guidelines.


πŸ“„ License

The documentation and examples in this repository are licensed under the MIT License.


πŸ‘€ Author

Nguyen Minh Thuan (Lucifer)

Last updated