Kwarde/sfcnr-wiki
1
0
Fork 0
Code Activity

Init repo

Browse Source
This commit is contained in:
Kwarde
2022-03-11 11:36:13 +01:00
commit 836ca68787
2 changed files with 85 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Home.md Normal file
View File

@@ -0,0 +1,7 @@
# SF-CNR Wiki Home
Official home of the SF-CNR Server Wiki
#### Server and scripting documentation
1. [Server Setup Guide](https://github.com/zeelorenc/sf-cnr/wiki/Server%20Setup%20Guide)

78
Server-Setup-Guide.md Normal file
View File

@@ -0,0 +1,78 @@
# SF-CNR Server Setup Guide
The setup guide is aimed to be as concise and simple as possible. It requires you to have very programming/logic skills.
### **1. Clone the repository**
1. Download a fresh install of SA-MP 0.3.7 (latest) server at [www.sa-mp.com](https://www.sa-mp.com/download.php)
2. [Clone the repository into your fresh SA-MP server directory.](https://confluence.atlassian.com/bitbucket/clone-a-repository-223217891.html)
### **2. Install all required includes and plugins**
Ideally, you want all plugins and includes to be up to date. But, included are the versions that are TESTED and WORKING.
If anything is missing during your setup, make an issue to the repository to have it addressed.
#### 2.1 Install Zeex's Improved Pawn Compiler
|**Version**|**Mirror**|
|---------|-----------|
|3.10.8|[pawn-lang/compiler](https://github.com/pawn-lang/compiler/releases)|
#### 2.2 Includes
|**Include** |**Version**|**Mirror** |
|-----------|:---------:|-----------|
|YSI|4.0|[pawn-lang/YSI-Includes](https://github.com/pawn-lang/YSI-Includes/releases)|
|MathParser|v0.1.0|[RyDeR/MathParser](https://forum.sa-mp.com/showthread.php?t=315364)|
|md-sort|latest|[oscar-broman/md-sort](https://raw.githubusercontent.com/oscar-broman/md-sort/master/md-sort.inc)|
|gangzones|v2.2|[Agneese-Saini/SA-MP](https://raw.githubusercontent.com/Agneese-Saini/SA-MP/master/pawno/include/gangzones.inc)|
|zcmd|0.3.1|[Zeex/zcmd](https://forum.sa-mp.com/showthread.php?t=91354)|
|modelsizes|latest|[Y-Less/modelsizes](https://gist.githubusercontent.com/Y-Less/4543512/raw/modelsizes.inc)|
|progressv2|2.1.2|[Southclaws/progress2](https://github.com/Southclaws/progress2/releases)|
#### 2.3 Plugins
|**Plugin** |**Version**|**Mirror** |
|-----------|:---------:|-----------|
|crashdetect|Latest|[Zeex/samp-plugin-crashdetect](https://github.com/Zeex/samp-plugin-crashdetect/releases)|
|mysql|R39-6|[pBlueG/SA-MP-MySQL](https://github.com/pBlueG/SA-MP-MySQL/releases)|
|gvar|v1.3|[samp-incognito/samp-gvar-plugin](https://github.com/samp-incognito/samp-gvar-plugin)|
|regex|v0.2.1|[Fro1sha/regex](https://forum.sa-mp.com/showthread.php?t=247893)|
|sscanf|2.8.2|[maddinat0r/sscanf](https://github.com/maddinat0r/sscanf/releases)|
|streamer|v.2.9.3|[samp-incognito/samp-streamer-plugin](https://github.com/samp-incognito/samp-streamer-plugin/releases)|
|Whirlpool|latest|[Southclaws/samp-whirlpool](https://github.com/Southclaws/samp-whirlpool/releases)|
|FCNPC|v1.8.2|[ziggi/FCNPC](https://github.com/ziggi/FCNPC/releases)|
|RouteConnectorPlugin|latest|[grasmanek94/SA-MP-GPS](https://github.com/grasmanek94/SA-MP-GPS/tree/master/Binaries)|
|sampcac_server|v0.10.0|[www.sampcac.xyz](https://sampcac.xyz/)|
|MapAndreas|v1.2.1|[philip1337/samp-plugin-mapandreas](https://github.com/philip1337/samp-plugin-mapandreas/releases)|
|TPoker|latest|*\* included in repository*|
|MerRandom|v2.1|[cyber_punk/MerRandom](https://forum.sa-mp.com/showthread.php?t=109196)|
|FileManager|1.5|[JaTochNietDan/SA-MP-FileManager](https://github.com/JaTochNietDan/SA-MP-FileManager/releases)|
### **3.0 Configure SF-CNR**
##### 3.1 Configure database settings
1. Go to `gamemodes/irresistible/config`
2. Rename `database.pwn.sample` to `database.pwn`
3. Set your MySQL settings for non-debug mode (production) and debug mode. You can make it the same, if you want (see 3.1).
##### 3.1 Debug Mode
* Debug mode can be turned on by having `#define DEBUG_MODE` at the top of `gamemodes/sf-cnr.pwn`
* Debug mode prevents maintainence queries from running during the startup, which are lengthy consuming.
* Debug mode prevents also player objects from being loaded to the server, improving compile time.
* Debug mode enables the d3 parameter on the compiler automatically so crashdetect can pickup any errors.
### **4.0 Load all database migrations (aka schemas)**
1. Go to `gamemodes/irresistible/config/migrations/cnr/`
2. Load phpMyAdmin or the MySQL CLI because [you will need to be able import/run SQL files](https://stackoverflow.com/a/17666279)
3. Run each `.sql` file one by one, ordered by the earliest date created *(files are formatted as date_server_description.sql)*
4. If there is an error running a specific migration SQL file, then maybe you have already loaded it otherwise redo the steps
### **5.0 Configure server.cfg**
A sample is provided automatically. The key things you want:
1. If you make any changes to your player count, make sure you change `#define MAX_PLAYERS` in `/gamemodes/sf-cnr.pwn` to whatever.
2. `maxnpc` at the moment is set to 210 which is the maximum the server uses. Your `maxplayers` should be `210 + [your player count]`
3. Load filterscript `sampcac_testscript` if you wish to enable the SA-MP CAC (3rd party) Anti-Cheat.