Krosmoz is a C# based emulator developed as a Proof of Concept (POC) for reverse engineering the 2.29 Dofus game. Leveraging .NET ecosystem, it emphasizes code quality, maintainability, and scalability. With automated CI/CD pipelines via GitHub Actions and a modular, multi-assembly architecture, Krosmoz offers cutting-edge features while ensuring reliability and ease of use.
The client is available at Krosmoz-Client.
| Feature | Description | |
|---|---|---|
| ⚙️ | Architecture | A C# solution structured with multiple projects in a single solution file (.sln), emphasizing modularity. Utilizes custom attributes and follows C# best practices. |
| 🔩 | Code Quality | Adopts code formatting tools such as EditorConfig or dotnet-format. Utilizes Roslyn analyzers and StyleCop for code consistency and maintainability. |
| 📄 | Documentation | Dependabot and GitHub Actions suggest automated documentation deployments. XML comments in .csproj files and inline comments imply good documentation practices. |
| 🔌 | Integrations | Uses GitHub Actions for CI/CD, enabling automated linting, builds, testing, and possibly deployment. |
| 🧩 | Modularity | Structured as a solution with multiple projects, enabling code reusability and separation of concerns within differently scoped libraries or applications. |
| 🧪 | Testing | GitHub Actions indicates testing as part of the CI process. Common test frameworks include xUnit. |
| ⚡️ | Performance | C# and .NET provide performance advantages, but detailed analysis of runtime efficiency or benchmarking would require deeper inspection. |
| 🛡️ | Security | Dependabot is configured for automatic dependency updates to mitigate vulnerabilities. Further audit required for specific security implementations. |
| 📦 | Dependencies | Direct dependencies include C# specific libraries and NuGet packages. Uses NuGet for standard package management practices. |
| 🚀 | Scalability | .NET's performance and the project's modularity favor scalability, but actual scalability would depend on specific implementation within the projects. |
Requirements
Ensure you have the following dependencies installed on your system:
- .NET9 SDK: The software development kit required to build and run C# applications.
- C#: The programming language used to develop this project.
- Docker: The platform used for containerization, allowing you to run applications in isolated environments.
- Clone the Krosmoz repository:
git clone https://github.com/AerafalGit/Krosmoz.git- Change to the project directory:
cd Krosmoz- Install the dependencies:
> dotnet restore
> dotnet build --no-restoreUse the following command to run Krosmoz:
> dotnet run --project src/Krosmoz.Servers.GatewayTo execute tests, run:
> dotnet testContributions are welcome! Here are several ways you can contribute:
- Submit Pull Requests: Review open PRs, and submit your own PRs.
- Report Issues: Submit bugs found or log feature requests for Krosmoz.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your GitHub account.
- Clone Locally: Clone the forked repository to your local machine using a Git client.
git clone https://github.com/AerafalGit/Krosmoz
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to GitHub: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
This project is protected under the MIT License. For more details, refer to the LICENSE file.