From d8f5b04df25f46be9b881e978975dd9668a75181 Mon Sep 17 00:00:00 2001 From: Vortrex <3858226+VortrexFTW@users.noreply.github.com> Date: Mon, 19 Dec 2022 10:36:10 -0600 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0daecd31..11bb1a2e 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ This is Vortrex's Roleplay Resource ## Setup * 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. -* Add this resource as-is into a resource folder of your choice inside the resources directory of your server. I named my resource folder "gtac_roleplay" +* Add this resource as-is into a resource folder of your choice inside the resources directory of your server. * Add the resource to the server config. You should also disable a lot of the cvars in the config too. I only have traffic, civilians, planes, and bigmap enabled. * Download the required modules and add them to your server config. See list of modules below. * Import the database to your MySQL server, and edit database.json in the resource's config folder with the info to connect to the database. * (Optional) Edit the email SMTP connection info. Without this, the email features will be disabled. * 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! ## Modules @@ -31,20 +31,20 @@ This is Vortrex's Roleplay Resource * Keep opening curly brackets in-line. Don't linebreak before an opening curly brackets. * Use sentence case instead of adjacent uppercase letters in class/member names. (i.e. Id instead of ID) * Use generic, non-specific class member names wherever possible. (i.e. databaseId instead of accountId) -* 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 server events are handled in `event.js` script file, sometimes with utils. +* All communications from server <-> client are handled in each side's `netevents.js` script files via utils +* All server and client events are handled in each side's `event.js` script files, sometimes with utils. ### Database Style -* Always use lowercase. -* Shorten prefix names to four characters or less (i.e. acct=account, veh=vehicle) +* Always use lowercase names for tables and fields +* Try to shorten prefix names to four characters or less (i.e. acct=account, veh=vehicle) * Add an underscore between each word * Append _main to any tables that store primary data (i.e. acct_main, ban_main, etc) * 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 both secondary indexes & cascading foreign key links to any ID that points to another table +* Tables use primary key on their ID column +* Tables use both secondary keys & cascading foreign key links to any ID that points to another table ### Notes * 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. -* 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, mostly related to permissions. +* Bitwise value of -1 is **always** used as "*all flags*" for that set. For admin permissions, -1 is god-tier admin level