macchiatoneko / tsukiyomi-engine

Tsukiyomi Game Engine

Welcome to Tsukiyomi, a game engine written in C++ with its editor built in C# using WPF. This repository is designed to serve as an educational resource for me to learn C++ and understand the fundamentals of game engine development.

Features

• C++ Game Engine: The engine is written in C++ and provides a foundation for game development.
• C# WPF Editor: Utilizes C# and WPF for the creation of an intuitive editor to interact with the engine.
• Modularity: Designed with modularity in mind, making it easy to understand various components and their interactions.
• Learning Resource: Intended as a learning tool for individuals interested in delving into game engine architecture and C++ programming.

Getting Started

Prerequisites

• Visual Studio (C++ Compiler)
• .NET Framework (for C# and WPF)

Compilation Instructions

1. Clone this repository to your local machine.

   git clone https://github.com/AtomSnow/tsukiyomi-engine.git

2. Compilation:

   • Open the TsukiyomiEngine solution in Visual Studio.
   • Set the TsukiyomiEditor as startup project.
   • Build all projects in solution to compile the C++ game engine and the editor.
   • Next to the solution there will be Release or Debug directory containing the build.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests with improvements, bug fixes, or additional features to enhance the learning experience for others.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

A huge thank you to all the contributors and open-source projects that have inspired and contributed to this educational endeavor.

Disclaimer

Tsukiyomi is a learning project and may not be suitable for production use yet. Use it primarily for educational purposes and experimentation for now.

---

Enjoy exploring Tsukiyomi! If you have any questions or suggestions, feel free to reach out and contribute to this project by opening issue/pull reqest. Happy coding!