AsgardEternal/SquadJS
1
0
Fork 0
mirror of https://github.com/AsgardEternal/SquadJS.git synced 2024-09-28 16:24:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #95 from LuisMartinSchick/master

Browse Source 
Updated Readme
This commit is contained in:
Thomas Smyth 2020-10-18 23:23:50 +01:00 committed by GitHub
commit efa48d1b51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -22,7 +22,7 @@
SquadJS is a scripting framework, designed for Squad servers, that aims to handle all communication and data collection to and from the servers. Using SquadJS as the base to any of your scripting projects allows you to easily write complex plugins without having to worry about the hassle of RCON or log parsing. However, for your convenience SquadJS comes shipped with multiple plugins already built for you allowing you to experience the power of SquadJS right away.
## Using SquadJS
SquadJS relies on being able to access the Squad server log directory in order to parse logs live to collect information. Thus, SquadJS must be hosted on the same server box as your Squad server.
SquadJS relies on being able to access the Squad server log directory in order to parse logs live to collect information. Thus, SquadJS must be hosted on the same server box as your Squad server or be connected to your Squad server via FTP.
### Prerequisites
* Git
@ -64,6 +64,7 @@ The following section of the configuration contains information about your Squad
* `rconPort` - The RCON port of the server.
* `rconPassword` - The RCON password of the server.
* `logReaderMode` - `tail` will read from a local log file. `ftp` will read from a remote log file.
* `logDir` - The folder where your Squad logs are saved. Most likely will be `C:/servers/squad_server/SquadGame/Saved/Logs`
* `ftpPort` - The FTP port of the server. Only required for `ftp` `logReaderMode`.
* `ftpUser` - The FTP user of the server. Only required for `ftp` `logReaderMode`.
* `ftpPassword` - The FTP password of the server. Only required for `ftp` `logReaderMode`.