RAGEMP ROLEPLAY GAMEMODE 0.0.7-b1

RAGEMP ROLEPLAY GAMEMODE

A perfect game mode to get started with if you're about to make a roleplay server!

This game mode is still work in progress, I will maintain and update it generally, plenty features are planned to be added so stay tunned!

At current state, this gamemode is perfect to be used as a boilerplate for you to start a rp server!

Built in:

Client side:

• Typescript
• Webpack

Server side

• Typescript
• Webpack
• Typeorm
• PostgreSQL

Frontend(CEF)

• ReactTS
• MobX

Current Features

•  - Account system (Login/Register).
•  - Character System (3 Available slots to create)
•  - Inventory System
•  - Notification system
•  - Chat System
•  - Command system

Getting started with setting up:

Database setup:
This code requires you to have PostgreSQL installed on your machine, read more at https://www.postgresql.org/
After installing PostgreSQL, connect to your database using PGAdmin or HeidiSQL and create a new database by executing a query like: 

CREATE DATABASE mydb;

After creating a database successfully, head back to the server files and edit .env by describing the database connection details there.
Once you're setup with that, simply start the server, and the TypeORM will start creating the required database tables on its own (see Database.module.ts for deeper info)

Code Structure:

ragemp-rp-gamemode
├───config #contains webpack configuration files
├───frontend
│   └───src
│       ├───assets #contains assets such as page images or videos
│       ├───events #contains page events which can be called from the backend
│       ├───pages #contains pages
│       ├───stores #contains temporary stores
│       ├───styles #contains global styling
│       └───utils #contains useful code methods
│
├───source #contains backend code
│   ├───client #contains client-side code
│   ├───server #contains server-side code
│   └───shared #contains shared data between server and client
│
└───.env #contains database connection details

Getting started with development:

(BACKEND)

1. Make sure you have an empty ragemp-server folder ready.
2. After downloading the gamemode, move all files to your ragemp-server folder.
3. Open the gamemode to your terminal and simply install the required packages executing 'npm install', this will install all required packages the gamemode uses.
4. After the packages are installed make sure you created the database explained above.
5. Start server-side in development mode: Simply execute 'npm run watch:server' to start watching server side in development mode.
6. Start client-side in development mode: Simply execute 'npm run watch:client' to start watching client side in development mode.

(FRONTEND)

1. Create a folder named package2 in client_packages folder.
2. Navigate to frontend folder in your terminal.
3. Install the required packages executing 'npm install'
4. Once packages are done installing simply run 'npm run build'
5. Once the build is done, it will automatically be moved to package2 folder.
6. Once you're done, start the server and that's pretty much it.

Github link: shr0x/ragemp-rp-gamemode: A startup rp script to make your way into making a rp server easier! (github.com)

More docs are in the github repo, also keep an eye since most of the updates will be published there first then will eventually be updated in this post.