From 01066435a4da7a22522acf83c2568e24994e055f Mon Sep 17 00:00:00 2001 From: rjindael Date: Fri, 7 Jul 2023 22:16:33 -0700 Subject: [PATCH] Add basic project description --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1165b66..11ecbda 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ # RNR -RNR's Not Roblox +RNR (**R**NR's **N**ot **R**oblox) is a project that aims to recreate the look and feel of classic Roblox while bringing in new features at the same time as well as remaining fully compatible with clients from that era. + +Interested in contributing? [Feel free to make a pull request!](https://github.com/kiseki-lol/RNR/pulls) + +# Objectives +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) +- Easy-to-use (simple CLI options to launch and host games, as well as a level editor with a modern UI) +- Fully compatible with Roblox versions up to 0.3.744.0 (dated April 2008) in areas such as hosting, joining, level file serialization, 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 +- 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 # License -All of RNR is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.txt) with the exception of the engine, which is licensed under the [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt). Copies of both licenses have been bundled with RNR. \ No newline at end of file +RNR is licensed under two separate licenses: +- The bulk of the code (which includes the player, studio, and server projects) are all licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.txt) license. +- The engine that RNR runs on is licensed under the [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt) license. + +Copies of both licenses have been bundled with RNR. \ No newline at end of file