hamyack/GTA4RP
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Vortrex
2023-01-19 22:19:26 -06:00
committed by GitHub
parent 4446aab960
commit 667dfb2167
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -2,7 +2,7 @@
### Description ### Description
This is Vortrex's Roleplay Resource This is Vortrex's Roleplay Resource
---
## Setup ## Setup
* Download the server from the [downloads page](https://gtaconnected.com/downloads) of the GTA Connected website. * Download the server from the [downloads page](https://gtaconnected.com/downloads) of the GTA Connected website.
* Download this resource via git clone or directly from GitHub with the green zip download button. * Download this resource via git clone or directly from GitHub with the green zip download button.
@@ -15,19 +15,18 @@ This is Vortrex's Roleplay Resource
* Start the server and connect. Register your account, make a character, and disconnect. * Start the server and connect. Register your account, make a character, and disconnect.
* Edit your account in the database (get your account ID from the acct_main table and then edit the four entries in acct_svr for your account, changing acct_svr_staff_flags to negative 1 (-1) ... **you must not be connected to the server when doing this** * Edit your account in the database (get your account ID from the acct_main table and then edit the four entries in acct_svr for your account, changing acct_svr_staff_flags to negative 1 (-1) ... **you must not be connected to the server when doing this**
* You now have full admin. Enjoy the resource! * You now have full admin. Enjoy the resource!
---
## Modules ## Modules
* [MySQL](https://github.com/VortrexFTW/mod_mysql) * [MySQL](https://github.com/VortrexFTW/mod_mysql)
* [Hashing](https://github.com/VortrexFTW/mod_hashing) * [Hashing](https://github.com/VortrexFTW/mod_hashing)
* [SMTP](https://github.com/VortrexFTW/mod_smtp) (Optional) * [SMTP](https://github.com/VortrexFTW/mod_smtp) (Optional)
---
### Git Branches ### Git Branches
*The nightly branch is not recommended for public server. Some features may or may not work as intended, or the script may be broken entirely. `master` will always be the stable branch, although slower to get new features.* *The nightly branch is not recommended for public server. Some features may or may not work as intended, or the script may be broken entirely. `master` will always be the stable branch, although slower to get new features.*
* master/main - The current release. *This branch is never committed to directly, only merged* * master/main - The current release. *This branch is never committed to directly, only merged*
* nightly - The next upcoming release. All feature/fix/change branches are merged into this one. * nightly - The next upcoming release. All feature/fix/change branches are merged into this one.
* feature/fix/change - This is where the stuff currently being working on goes into. * feature/fix/change - This is where the stuff currently being working on goes into.
---
### Scripting Style ### Scripting Style
* Always use camelCase, even for event names. * Always use camelCase, even for event names.
* Use a util function where possible. Keep raw logic in command/event/network handlers to a minimum. * Use a util function where possible. Keep raw logic in command/event/network handlers to a minimum.
@@ -37,7 +36,7 @@ This is Vortrex's Roleplay Resource
* All communications from server to client are handled in server-side `client.js` script file via utils * All communications from server to client are handled in server-side `client.js` script file via utils
* All communications from client to server are handled in client-side `server.js` script file via utils * All communications from client to server are handled in client-side `server.js` script file via utils
* All server events are handled in `event.js` script file, sometimes with utils. * All server events are handled in `event.js` script file, sometimes with utils.
---
### Database Style ### Database Style
* Always use lowercase. * Always use lowercase.
* Shorten prefix names to four characters or less (i.e. acct=account, veh=vehicle) * Shorten prefix names to four characters or less (i.e. acct=account, veh=vehicle)
@@ -46,8 +45,10 @@ This is Vortrex's Roleplay Resource
* Prefix field names with the table name, except for _main tables (i.e. acct_id, job_loc_id) * Prefix field names with the table name, except for _main tables (i.e. acct_id, job_loc_id)
* Tables use primary index on their ID column. * Tables use primary index on their ID column.
* Tables use both secondary indexes & cascading foreign key links to any ID that points to another table * Tables use both secondary indexes & cascading foreign key links to any ID that points to another table
---
### Notes ### Notes
* The resource is designed to load the script files first, then initialize after that's done. * The resource is designed to load the script files first, then initialize after that's done.
* The IDEAS.md file is not a to-do list. It's just a random file to throw ideas into when they come to mind. * The IDEAS.md file is not a to-do list. It's just a random file to throw ideas into when they come to mind.
* Bitwise values are used for several different aspects related to permissions. The value of -1 is **always** used as "*all flags*" for that set. * Bitwise values are used for several different aspects related to permissions. The value of -1 is **always** used as "*all flags*" for that set.
* The script does not fade in the game camera. You'll need the [v-roleplay-intro](https://github.com/VortrexFTW/v-roleplay-intro) for that.
* The script does not contain any content except item types. You need to spawn all businesses, houses, vehicles, jobs, job routes, etc.