https://github.com/comodinoh/gcrisp
Engine for creating Visual Novel games written in C++
https://github.com/comodinoh/gcrisp
cmake cpp cpp20
Last synced: 11 months ago
JSON representation
Engine for creating Visual Novel games written in C++
- Host: GitHub
- URL: https://github.com/comodinoh/gcrisp
- Owner: Comodinoh
- License: gpl-2.0
- Created: 2024-11-09T10:33:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-11T19:01:55.000Z (about 1 year ago)
- Last Synced: 2025-05-11T20:18:38.742Z (about 1 year ago)
- Topics: cmake, cpp, cpp20
- Language: C
- Homepage:
- Size: 759 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
Hi!
GCrisp is a project that I've been wanting to do for ages.
It's a game engine written in C++ to make creating multilingual Visual Novels easier
and more flexible for all types of stories and styles.
Since I'm a beginner to this kind of thing,
please bear with me if I make any mistakes along the way. I will dedicate as much time as I can
to the development of this engine, but between school and personal life,
the progress I make will be a bit uneven. Still, I'm excited and motivated to see this through
and to work through the hardships that I might encounter along this road!
For this engine, I am planning to support multiple rendering APIs, like OpenGL, Vulkan and DirectX.
The goal is to make it compatible with Windows, Linux, Android (if I can)
and maybe IOS and/or MacOS too, if I have the time to figure out Metal as the backend rendering API.
I'll try to make the engine as easy-to-use as possible, while still focusing on efficiency and performance.
I know this will be a big challenge to tackle, but it sounds pretty fun and I'd like to try that.
The engine architecture is inspired by the Hazel game engine series made by [TheCherno](https://www.youtube.com/@TheCherno) on YouTube.
I've been learning a lot from watching him and I hope you can check it out for yourself too.
If you want to help in any way or have advice or suggestions, feel free to let me know
and we can discuss further! Thanks for checking this out and I hope this community will be fun!
# Usage
## Linux
__Note:__ CMake >= 3.30.4 required
To use GCrisp in your project, you can import it with CMake by making a submodule:
```bash
git submodule add https://github.com/Comodinoh/GCrisp.git lib/GCrisp
git submodule update --init --remote --recursive lib/GCrisp
```
Then add that folder as a subdirectory in your `CMakeLists.txt` file and link the library with:
```CMake
add_subdirectory(lib/GCrisp)
target_link_libraries(${PROJECT_NAME} PUBLIC gcrisp)
```
## Windows
__Note:__ CMake >= 3.30.4 required
Using GCrisp on windows is similar.
You can compile the project in both Visual Studio or CLion,
whether it'd be with MSVC, CLang or GCC (I usually find GCC compilation times on windows to be significantly slower than on linux for some reason).
I am personally testing MSVC and CLang support and working towards improving it.
# Getting Started
I recommend checking out the [wiki](https://github.com/Comodinoh/GCrisp/wiki) to get started with the engine (Still work in progress!).