Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guicaulada/yarp

A RAGE-MP Roleplay Framework
https://github.com/guicaulada/yarp

ragemp

Last synced: about 2 months ago
JSON representation

A RAGE-MP Roleplay Framework

Awesome Lists containing this project

README

        

# Yet Another Roleplay - RAGE-MP

YARP aim's to be an object oriented framework that allows you to create persistent objects dynamically.
### :warning: This project is still under development, many changes can happen to the code. :warning:
### :warning: This project is NOT ready for production, use only for development. :warning:

## Requirements
* [RAGE-MP](http://rage.mp) - RAGE Multiplayer is an multiplayer modification for Grand Theft Auto V that is alternative to GTA Online.
* [nodejs](https://nodejs.org) - A JavaScript runtime built on Chrome's V8 JavaScript engine.
* [mongodb](https://www.npmjs.com/package/mongodb) - A document database with the scalability and flexibility that you want with the querying and indexing that you need.
* [bcryptjs](https://www.npmjs.com/package/bcryptjs) - Optimized bcrypt in JavaScript with zero dependencies.
* [chalk](https://www.npmjs.com/package/chalk) - Terminal string styling done right.
* [python](https://www.python.org/download/releases/2.7.8/) - Python is a programming language that lets you work more quickly and integrate your systems more effectively.

## Installation

1. Download or clone the repository.
2. Extract the files to your RAGE-MP server-files folder.
3. Using a command prompt window install these modules on your server-files folder.
* Run the command prompt as administrator.
* `cd C:/server-files` *(use your server path)*
* `npm install`

## Features
* **Whitelist**
* **MongoDB Database**
* **Dynamic & Persistent**
* **Secure Authentication**
* **Multiple Characters**
* **More to come...**

## Usage

YARP is still under development, information will be added here in the future. See [documentation](https://sighmir.github.io/YARP_docs/).

## License

YARP - Yet Another Roleplay
Copyright (C) 2018 Sighmir

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .

## Acknowledgments
*Thanks to the following people who in some way or another, has helped with this project:*

* [Shadow](https://github.com/shadowbrz)
* [ImagicTheCat](https://github.com/ImagicTheCat)
* [xabier1989](https://github.com/xabier1989)
* [BlueDadjun](https://github.com/BlueDadjun)
* [Stuyk](https://github.com/Stuyk)
* [rootcause](https://rage.mp/profile/17917-rootcause)