Skip to content

Latest commit

 

History

History
139 lines (102 loc) · 4.91 KB

README.md

File metadata and controls

139 lines (102 loc) · 4.91 KB
Raw

alt:V - Open Roleplay

Remember to 🌟 this Github if you 💖 it.

THIS IS A WORK IN PROGRESS AND IS NOT COMPLETE IN ANY WAY.**

Open Roleplay is a base gamemode for Roleplay servers. It will include the ideal functionality to get the base ground work for a roleplay gamemode started.

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.

Roadmap

  • PostgreSQL Integration
  • Login and Registration
  • Character Facial Customization
  • Roleplay Name Formatting
  • Character Clothing Customization
  • Character Inventory System
  • Vehicle System
  • Vehicle Customization
  • Vehicle Fuel System
  • Nametags / Character Names
  • Door System
  • Door Sales System
  • Administrative Toolkit
  • Currency System
  • Shop System
  • Faction System
  • Basic Anticheat

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 joining discord.

Installation

If you don't have NodeJS; please go install it.

The file structure below is the required structure you must use for this game mode. You must follow it exactly for this resource to work.

  • Grab the latest version of the alt:V server files. They must be clean. No resources.

  • Download Chat-Extended and rename the resource to chat and place it inside of your resources folder. Open up server.mjs inside of chat and change cancelAllChat to true. This enables ranged chat for this resource. Directly inside you should have resource.cfg if done correctly.

  • Download Postgres-Wrapper this is the Postgres SQL helper that was written to make database usage easy. Extract it and put this into a folder called postgres-wrapper. Directly inside you should have resource.cfg if done correctly.

  • Install the latest version of PostgresSQL for either windows, linux, or whatever OS you're running.

  • Once installed you need to create a username and password for your database; and create a database called 'altv' or something else if you know what you're doing. PAY ATTENTION HERE YOU'LL NEED THIS INFO

Creating on Windows with pgAdmin4 Where to navigate:

Postgres is the username for this database; and altv is the name:

After; it should be running automatically in your services on windows. You can always restart your database through your Task Manager.

  • Download the latest version of this resource. You can either clone the repository or simply download it. The resource.cfg and the rest of the files should be directly inside of a folder called orp.

  • To configure your database navigate to resources/orp/server/configuration/ and open database.mjs. Fill out the required parameters; and change them to what you setup PostgreSQL with.

Example Database Configuration

export const DatabaseInfo = {
    username: 'postgres',
    password: 'abc123',
    address: 'localhost',
    port: 5432,
    dbname: 'altv'
};

Example Folder Structure

altVServerFolder/
└── resources/
|   ├── chat/
|   |   ├── index.mjs
|   |   ├── client.mjs
|   |   ├── resource.cfg
|   |   └── html/
|   ├── orp/
|   |   ├── server/
|   |   ├── client/
|   |   └── resource.cfg
|   ├── postgres-wrapper/
|   |   ├── client.mjs
|   |   ├── database.mjs
|   |	└── resource.cfg

*Installing Packages for NodeJS After installing the above; if you don't have a package.json in your main server directory where your .exe is you're going to need to do the following:

Open a command prompt or powershell next to your .exe file

npm init

Then press enter a bunch of times until its done stepping you through.

After you need to install the following packages from command prompt or power shell.

npm install --save typeorm
npm install --save pg
npm install --save sjcl

Great; now you have all the prerequisites.

Open your server.cfg next to your altv-server.exe.

You need to add orp to resources.

name: 'Open RP'
host: 0.0.0.0
port: 7766
players: 1000
announce: false
gamemode: OpenRP
website: twitch.tv/stuykgaming
language: lang-here
description: 'Using Open Roleplay'
modules: [ node-module ]
resources: [ orp ]
token: ''
debug: 'true'

That's about it; once you run it you'll be greeted with terms and conditions and you can follow the additional instructions from there.