From 79086a283a3331ac122305bf64c4509c0ab072be Mon Sep 17 00:00:00 2001 From: rjindael Date: Fri, 7 Jul 2023 22:34:53 -0700 Subject: [PATCH] Add build instructions --- README.md | 18 ++++++++++++++++-- rsc/content/.gitkeep | 0 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 rsc/content/.gitkeep diff --git a/README.md b/README.md index 11ecbda..a548b8a 100644 --- a/README.md +++ b/README.md @@ -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) -# Objectives +# Goals There are several goals that RNR seeks to achieve, those being; - Full native x64 support on Windows and Linux - 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.) - 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) -- 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 RNR is licensed under two separate licenses: diff --git a/rsc/content/.gitkeep b/rsc/content/.gitkeep new file mode 100644 index 0000000..e69de29