36 lines
660 B
Markdown
36 lines
660 B
Markdown
|
# CeeV
|
||
|
|
|
||
|
|
A simple visual novel engine written in C++.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
### Building
|
||
|
|
|
||
|
|
CeeV uses CMake to build. To build, run the following commands:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
mkdir build
|
||
|
|
cd build
|
||
|
|
cmake ..
|
||
|
|
make
|
||
|
|
```
|
||
|
|
|
||
|
|
### Running
|
||
|
|
|
||
|
|
To run CeeV, run the following command:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./CeeV <path to .cv file>
|
||
|
|
```
|
||
|
|
|
||
|
|
## File Format
|
||
|
|
|
||
|
|
CeeV uses a custom file format to store visual novel data. The file format is described in [FILE_FORMAT.md](FILE_FORMAT.md).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
CeeV is licensed under the AGPL-3.0 License. See [LICENSE](LICENSE) for more information.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|