92ddbb0f8f7ba0c32768d278e98f569d2390218b
Asshat Gaming
GTA Connected Roleplay Division
Description
This is the roleplay resource for Asshat Gaming's GTAC servers
Git Branches
- master/main - The current release. Never commit to this branch directly
- testing - The next upcoming release. All feature/fix/change branches are merged into this one
- feature/fix/change - This is where the stuff you're currently working on goes into.
Getting Started
- Download the GTAC server to your local PC. This will be your local test server.
- Unzip the server, and edit the server config (default is server.xml) to your liking.
- Run plink.exe to create an SSH tunnel.
plink.exe gtacrp.asshatgaming.com -P 40393 -l USERNAME -i PATHTOKEY -L 127.0.0.1:3307:127.0.0.1:3306- Replace USERNAME with your username
- Replace PATHTOKEY with the full file path to your private key
- If desired, change the first port from 3307 to whatever you want. This will tunnel the mysql connection to that port to use on your PC.
- Put the edited command into a batch file (.bat) to make it easier to use next time.
- Add your MySQL access info to the database.json config in the resource's config directory. Use the tunneled port above!
- Clone this git repository into a subdirectory within the server's resources folder.
- Add the subdirectory's folder name to the resources section of the server config.
- Start the server to make sure it works and connects.
- Make a branch based on
testingfor every new feature/fix/change and prefix it with one of those (i.e.feature-something) - Test the feature, and if it works, merge the branch for it into testing branch
Scripting Style
- Always use camelCase, even for event names.
- Use a util function where possible. Keep raw logic in command/event/network handlers to a minimum.
- 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
client.jsscript file via utils - All server events are handled in
event.jsscript file, sometimes with utils.
Database Style
- Always use lowercase.
- 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
Notes
- The resource is designed to load the script files first, then initialize after that's done.
- Never edit scripts directly on the server. Always edit in the cloned repo on your PC.
- Never upload scripts to the main server. Vortrex will handle deployment of public releases.
- 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.
- Delete the row containing the bug or idea from the database once you've scripted and tested it and it works.
Description
Languages
JavaScript
100%