Merge branch 'testing'

This commit is contained in:
Vortrex
2021-04-24 11:05:18 -05:00
115 changed files with 11337 additions and 6852 deletions

View File

@@ -9,22 +9,6 @@ This is the roleplay resource for Asshat Gaming's GTAC servers
* 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.
* Add a CVAR to the server config called `devserver` and set it's value to "1" to use the dev server database.
* 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
* Put the edited command into a batch file (.bat) to make it easier to use next time.
* Add a CVAR to the server config called `databaseport` and set it's value to 3307.
* 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 `testing` for 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.