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

Update README.md

This commit is contained in:
thexkey 2023-07-22 10:45:48 -07:00 committed by GitHub
parent e5efb806f6
commit b93b966753
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,29 +1,18 @@
# RNR's Not Roblox
[![GitHub CI Status](https://img.shields.io/github/actions/workflow/status/lrre-foss/rnr/build.yml?branch=trunk&label=builds)](https://github.com/lrre-foss/rnr/actions)
[![Discord](https://img.shields.io/discord/1130992923329175552?style=social&logo=discord)](https://discord.gg/2tj4TREby3)
[![Star](https://img.shields.io/github/stars/lrre-foss/RNR?style=social)](https://github.com/lrre-foss/RNR/stargazers)
# NOTICE
This is a fork of RNR, with placeholder-specific changes. The license of the code has also been changed to AGPLv3.
These changes may or may not compile on all platforms/configurations properly.
# RNR's Not Roblox (PLH)
[![GitHub CI Status](https://img.shields.io/github/actions/workflow/status/PlaceholderLabs/rnr/build.yml?branch=trunk&label=builds)](https://github.com/PlaceholderLabs/rnr/actions)
**R**NR's **N**ot **R**oblox (RNR) is a project that aims to recreate the look and feel of classic Roblox with new features while remaining fully compatible with clients from that era. It is built upon an engine that closely resembles Roblox's own at the time, referencing disassemblies of legacy client binaries.
Interested in contributing? Feel free to [make a pull request](https://github.com/lrre-foss/RNR/pulls), [create a new issue](https://github.com/lrre-foss/rnr/issues) for a feature request or to report a bug, [join the Discord](https://discord.gg/2tj4TREby3) to report bugs and communicate directly with the developers, or check out the [RNR GitHub Project](https://github.com/orgs/lrre-foss/projects/1) to see what we're working on and have done so far.
Check out our current progress on YouTube:
- [Block Town showcase](https://www.youtube.com/watch?v=-V2VUjxpNLs)
- [Doomspires 3.4k parts physics demo](https://www.youtube.com/watch?v=M0nn658uZ34)
- [Angel of Truth 8k+ parts physics demo](https://www.youtube.com/watch?v=EW6G_R6lx_Q)
P.S.: You can check our [GitHub actions page](https://github.com/lrre-foss/rnr/actions) to browse packaged Windows builds automatically generated for each commit. :-)
## Features and Goals
There are several goals that RNR seeks to accomplish, them being;
- Full native x64 support on Windows and Linux
- 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, levels, etc.
- Incorporates all the various facets of the Roblox engine, plus a little bit extra (e.g. a network replication whitelist, fancy shader support, etc.)
- Made using clean-room reverse engineering
- Uses Roblox's [Luau](https://luau-lang.org/) as its scripting language while remaining fully compatible with classic Roblox scripts written using Lua 5.1
- As free and open-source as possible (with client code licensed under the GPL and the engine itself being released into the public domain, void of any copyright)
- Patching all the security vulnerabilities and fixing bugs/inefficiencies that legacy Roblox clients had
There are several goals that RNR-PLH seeks to accomplish, them being;
- Networking via the Tor Network (`zTORNetworking` branch) once upstream server/player can be used reliably
- Whatever silly ideas we come up with in the future
## 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:
@ -37,17 +26,17 @@ For Windows:
- If you're building ***for*** 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 the root of the repository. Proprietary Roblox assets are not included with RNR.
Additionally, you must also acquire the `content` folder of the Roblox client you would like to use its resources from and place it in the root of the repository. 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:
- All of RNR, with the sole exception of the engine, is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.txt).
RNR-PLH is licensed under two separate licenses:
- All of RNR-PLH, with the sole exception of the engine, is re-licensed from upstream under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.txt).
- The RNR engine itself 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.
Copies of both licenses have been bundled with RNR-PLH.
RNR uses the [Luau](https://luau-lang.org/) language and code, developed by Roblox Corporation. Luau is copyright (c) 2019-2022 Roblox Corporation and copyright (c) 1994–2019 Lua.org, PUC-Rio.
This repository hosts no proprietary Roblox assets. RNR is not associated with Roblox Corporation in any way, shape, or form.
RNR is not associated with, does not deal with, not approved by, not a subsidy of, or otherwise part of Roblox Corporation in any way, shape, or form.