You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-14Lines changed: 28 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
# openJuice
2
2
3
-
## Overview:
3
+
## Overview
4
+
4
5
🍊 Open-source re-engineering of the game [*100% Orange Juice!*](https://store.steampowered.com/app/282800), written as a love letter to the original game.
5
6
This does not aim to be a one-to-one recreation of the game but rather a port of the game as a TUI program.
6
7
@@ -13,27 +14,32 @@ Tested for Linux. Windows and MacOS support untested.
Localisation files are not included. Users must supply localisation data in the format shown by [100-Orange-Juice-Public-Defines](https://github.com/FruitbatFactory/100-Orange-Juice-Public-Defines/).
17
19
18
20
The official repository cannot be legally included in this repository, but localisation files match this format and are expected to be in a directory called `./assets/define`. This project does not distribute or endorse any specific data source.
19
21
20
22
Audio files are not included either.
21
23
22
-
## Build:
23
-
Requires C++26, and a build system such as CMake (minimum version 3.30) or XMake. The project has not yet been tested for GCC or MSVC, so we recommend only compiling with Clang for now.
24
+
## Build
25
+
26
+
Requires C++26, and a build system such as CMake (minimum version 3.30) or XMake. The project has not yet been tested for GCC or MSVC, so we recommend only compiling with Clang for now.
24
27
25
28
### CMake
29
+
26
30
> **Info:** Requires CMake ≥3.30 and the Ninja build system.
27
31
> Makefiles generated by CMake currently do not support modules.
28
32
29
-
Any way of calling CMake is fine.
33
+
Any way of calling CMake is fine.
30
34
31
35
The simplest way to build the project is using the Makefile, which calls CMake:
36
+
32
37
```sh
33
38
make build SANITIZERS=all
34
39
```
35
40
36
41
Or, by manually calling CMake:
42
+
37
43
```sh
38
44
# Sets source directory to current directory, build directory to ./build/, and generates Ninja build system files
39
45
cmake -S . -B build -G Ninja
@@ -48,7 +54,8 @@ cmake --build build
48
54
We have also written a Python script to simplify using CMake, which can be run with `./quick_cmake_build.py`. (Simply execute the script `quick_cmake_build.py` to compile the program with CMake.) If [JBang](https://github.com/jbangdev/jbang) is installed, `QuickCMakeBuild.java` can also be executed as a script.
0 commit comments