Remember to π this Github if you π it.
Open Roleplay is the base framework for my server: alt:V Life. Open Roleplay has its own Official Discord.
I have put a ton of work into this project. If you do not want to contribute code and you use this project at least buy me some coffee; I could use it.
- Don't Monetize this Game Mode
- Don't Remove Splash Marks
- Don't Remove O:RP Links or Twitch Links from gamemode.
You can find a full list of features and the roadmap here.
IMPORTANT If you are not a developer; this may not be the project for you. There is some general configuration that needs to be done and understanding code is important.
I will not be providing direct support for this gamemode; if you have an issue or come across actual functionality issues please raise an issue in the issues tab. Otherwise; additional help can be found by subscribing through my twitch page and then joining the Discord Group
Tab --------> Press to Toggle Cursor
Tab + RMB -> Show Context Menu on User
Tab + LMB -> Select Context Option
T ----------> Open Chat
F1 ---------> Help Menu
U ----------> Open Gang Menu (Notoriety 25+)
Shift + F7 -> Toggle Chat
Requirements:
-
Basic Programming Fundamentals
-
Basic Problem Solving Fundementals
-
Linux (Ubuntu 18+ Preferred) or Windows 10+
-
PostgresSQL v10 to v11.5
-
PLEASE DO NOT DOWNLOAD v12. IT WILL NOT WORK.
-
-
Run the .exe and follow the prompts.
-
Run pgAdmin
-
You will be prompted for a password. This is your database password.
-
After you need to create a database called
altv
. -
Here's a very brief
streamable example
of that taking place.
- Note: By default your username will be
postgres
and your password will be whatever you use to log in to pgAdmin4.
-
Type:
su - postgres
-
Type:
psql
-
Type:
CREATE DATABASE altv;
-
If all is well you will see
CREATE DATABASE
or something similar replied. -
Type:
CREATE USER stuyk WITH ENCRYPTED PASSWORD 'abc123';
-
If all is well you will see
CREATE ROLE
replied. -
We now have a user called
stuyk
with a password ofabc123
. We need to assign to db. -
Type:
GRANT ALL PRIVILEGES ON DATABASE altv TO stuyk;
-
If all is well you wil see
GRANT
replied. -
Type:
\q
to exit. -
Type:
sudo -u root
-
This will bring you back to your root account.
-
Now follow the rest of the steps below.
-
Open a Power Shell or Command Prompt or Terminal
-
Download the latest version of this resource (100% Recommend CLONING the REPO with GIT).
-
After CLONING, CD into the repo through the same command prompt.
-
Open a command prompt and run
npm run orp
. FOLLOW THE INSTRUCTIONS CAREFULLY ON PROMPT. -
When you get to the Discord Setup; make sure you hit 'yes' if this is a new server.
Please Create a Discord Application for your Login System.
Please Visit: https://discordapp.com/developers/applications/
-
Inside of page you need to create a Discord Application and turn it into a bot and copy the bot secret.
-
You also MUST add this bot to your own server.
- Hit New Application
- Set the Name for Your Bot / Application
- Click on the
Bot
tab. - Transform your Application into a bot.
- Name your bot.
- Tick
Administrator
or justSend/Read Messages
- Copy the bots secret token.
- Make sure the bot is not public.
- Navigate to oAuth2 tab. Tick
bot
in scopes. - Copy the URL inside of scopes. Paste in browser.
- Add the bot to your designated Discord.
- Make sure you save your changes.
- Keep this page open for the next section.
-
Clone this repository from github.
-
Open a Command Prompt or Power Shell Prompt in cloned directory.
-
Type
npm run orp
to begin the installation process. -
You will be asked to agree to some terms and conditions.
-
You will be prompted for various installation steps and must provide the information asked for.
-
After filling in all information you are prompted for the server files will download.
-
We target beta branch with this gamemode.
-
Start your server based on whichever platform you use.
-
Run these from a terminal or command prompt.
-
Windows ->
altv-server.exe
-
Linux ->
./start.sh
-
-
Join your server with Discord Open.
-
IF DISCORD DOES NOT PROMPT YOU Copy the code on screen.
-
PM the Bot you setup earlier with
!login <code>
If you do not know what docker is. Please do not proceed any further.
OpenRP includes support for building and running the alt:V and PostgreSQL server using Docker. Included is a docker-compose.yml which contains many variables that you will need to edit. Any changes you make will require you to rebuild the altv-openrp container.
To build new containers, first edit the docker-compose.yml file and fill in all the details for the altv server and discord information, and then build with docker-compose. Note: You must agree with OpenRP terms of service by passing TOS_AGREE=true as a build argument.
docker-compose build --build-arg TOS_AGREE=true
To run the containers:
docker-compose up
Please see Docker and Docker-Compose documentation for more options.