https://github.com/star-hengxing/Yuzuyu
A modern visual novel engine
https://github.com/star-hengxing/Yuzuyu
cpp20 galgame game visual-novel visual-novel-engine xmake
Last synced: about 1 month ago
JSON representation
A modern visual novel engine
- Host: GitHub
- URL: https://github.com/star-hengxing/Yuzuyu
- Owner: star-hengxing
- License: gpl-3.0
- Created: 2023-02-26T15:23:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-05T13:08:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T13:58:57.487Z (6 months ago)
- Topics: cpp20, galgame, game, visual-novel, visual-novel-engine, xmake
- Language: C++
- Homepage:
- Size: 288 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yuzuyu Visual Novel Engine
The name Yuzuyu comes from the translation of the character 柊ゆずゆ in [フレラバ](https://ja.wikipedia.org/wiki/%E3%83%95%E3%83%AC%E3%83%A9%E3%83%90_%E3%80%9CFriend_to_Lover%E3%80%9C).
> This is work in progress. Do not using it in production.
# Getting started
## Dependencies
- [xmake](https://xmake.io/#/guide/installation)
- Requires C++20 compiler.
## Setup
### Windows 10
Install msvc toolchain.
Recommend use [scoop](https://scoop.sh/) as package manager.
```sh
scoop install xmake vulkansdk
```
### Arch Linux
TODO
## Build
Clone repo, then try
```sh
xmake f -m debug -y
xmake build sandbox
```
After build, try
```sh
xmake run sandbox
```
If you want to accelerate to compile with C++20 stl header units, try
```sh
xmake f --modules=y
```
> Only msvc support now.
## Test
```sh
xmake f -m debug --test=y
xmake build -g test
xmake run -g test
```
# Dependent third-party libraries
- [vulkan](https://vulkan.lunarg.com/sdk/home)
- [volk](https://github.com/zeux/volk)
- [vk-bootstrap](https://github.com/charles-lunarg/vk-bootstrap)
- [vulkan-memory-allocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator)
- [glfw](https://github.com/glfw/glfw)
- [sdl](https://www.libsdl.org/)
- [spdlog](https://github.com/gabime/spdlog)
- [fast_io](https://github.com/cppfastio/fast_io)
- [libpng](https://github.com/glennrp/libpng)
- [libjpeg-turbo](https://github.com/libjpeg-turbo/libjpeg-turbo)
- [avir](https://github.com/avaneev/avir)
- [freetype](https://github.com/freetype/freetype)
- [ffmpeg](https://github.com/FFmpeg/FFmpeg)
- [toml++](https://github.com/marzer/tomlplusplus)
- [boost_ut](https://github.com/boost-ext/ut)