Skip to content

Commit 9249cfc

Browse files
committed
Update README.md
1 parent 7c458e1 commit 9249cfc

File tree

1 file changed

+36
-3
lines changed

1 file changed

+36
-3
lines changed

README.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Nova is a community-focused, open-source game engine built in C++20. It is designed to capture the soul and aesthetic of the "classic" era of online building games (2007), while utilizing modern reflection and rendering techniques.
44

55
## 🌟 The Vision
6-
Nova is born out of a desire to return to a simpler, community-driven platform, that ROBLOX used to be back in the day. We are here to preserve the aesthetics, but provide modern tooling to support modern developers using our game engine!
6+
Nova is born out of a desire to return to a simpler, community-driven platform, that ROBLOX used to be back in the day. We are here to preserve the aesthetics, but provide modern security, and modern tooling to support modern development.
77

88
## 🛠️ Tech Stack
99
- **Language:** C++20
@@ -19,6 +19,39 @@ Nova is an independent project and is not affiliated with, sponsored by, or endo
1919
This project utilizes certain legacy textures, meshes, and sounds originally created by Roblox Corporation (c. 2007-2009). These assets are used under the principles of preservation and are the intellectual property of Roblox Corp. Nova is intended as a "clean-room" engine implementation; the source code is entirely original and licensed under the GPL v3.
2020

2121
## 🚀 Getting Started
22-
We will add these later... coming soon
22+
### Configuring CMake
2323

24-
Very WIP! Only reflection and basic 2007 RBXL parsing.
24+
vcpkg:
25+
to configure and build, you must install vcpkg:
26+
```bash
27+
git clone https://github.com/microsoft/vcpkg.git
28+
29+
cd vcpkg
30+
31+
.\bootstrap-vcpkg.bat # On Windows
32+
# or
33+
./bootstrap-vcpkg.sh # On Linux/macOS
34+
```
35+
36+
Configure with the standard cmake command:
37+
```bash
38+
cmake -B build -G Ninja -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Debug
39+
```
40+
41+
`-DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake` please point this to the vcpkg/scripts/buildsystems/vcpkg.cmake
42+
`-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` is optional, unless you want full IDE support.
43+
`-G Ninja` is also optional, but highly recommended over make.
44+
`-DCMAKE_BUILD_TYPE=Debug` you can change this to Release, or other CMake build types
45+
46+
47+
### Building with CMake
48+
49+
Build with the standard cmake command:
50+
```bash
51+
cmake --build build
52+
```
53+
You can also use `ninja` or `make` in the directory `build` but this is much better, and it auto-detects!
54+
55+
## Contributing
56+
57+
We welcome all kinds of contributions, as long as you maintain the charm and aesthetics of 2007, and the code is safe and secure.

0 commit comments

Comments
 (0)