Placeholder
/
rnr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add build instructions

This commit is contained in:
rjindael 2023-07-07 22:34:53 -07:00
parent 01066435a4
commit 79086a283a
No known key found for this signature in database
GPG Key ID: D069369C906CCF31
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -3,7 +3,7 @@ RNR (**R**NR's **N**ot **R**oblox) is a project that aims to recreate the look a
Interested in contributing? [Feel free to make a pull request!](https://github.com/kiseki-lol/RNR/pulls) Interested in contributing? [Feel free to make a pull request!](https://github.com/kiseki-lol/RNR/pulls)
# Objectives # Goals
There are several goals that RNR seeks to achieve, those being; There are several goals that RNR seeks to achieve, those being;
- Full native x64 support on Windows and Linux - Full native x64 support on Windows and Linux
- Efficient and powerful renderer built from scratch (with only OpenGL support for the time being) - Efficient and powerful renderer built from scratch (with only OpenGL support for the time being)
@ -12,7 +12,21 @@ There are several goals that RNR seeks to achieve, those being;
- Incorporates all the various facets of the Roblox engine, with a little bit extra (e.g. a network replication whitelist, fancy shader support, etc.) - Incorporates all the various facets of the Roblox engine, with a little bit extra (e.g. a network replication whitelist, fancy shader support, etc.)
- Made with clean-room reverse engineering - Made with clean-room reverse engineering
- As free and open-source as is possible (with client code being licensed under the GPL and the engine itself released into the public domain, void of any copyright) - As free and open-source as is possible (with client code being licensed under the GPL and the engine itself released into the public domain, void of any copyright)
- Patches all the security vulnerabilities and bugs that legacy Roblox clients contained - Patching all the security vulnerabilities and bugs that legacy Roblox clients had
# Building
RNR uses [CMake](https://cmake.org/) as its build system and [GCC](https://gcc.gnu.org/) as its compiler. To build RNR, you must first have the following packages installed:
- [Boost](https://www.boost.org/)
- [CGLM](https://github.com/recp/cglm)
- [Qt 6](https://www.qt.io/product/qt6) (if building the player or studio projects)
For Windows:
- If you're *targeting* Windows, [MinGW-w64](https://www.mingw-w64.org/) is the preferred toolset of choice.
- If you're *building on* Windows, you may use a platform such as [MSYS2](https://www.msys2.org/), which provides an all-in-one environment for running MinGW or GCC.
Additionally, you must also acquire the content folder of the Roblox client you would like to use its resources from and place it in `rsc/content`. Proprietary Roblox assets are not included with RNR.
Finally, you may run `cmake --build .` in the path of the folder you've cloned the repository to so that you may configure and then finally build RNR.
# License # License
RNR is licensed under two separate licenses: RNR is licensed under two separate licenses:

0
rsc/content/.gitkeep Normal file
View File