GITBOOK-30: change request with no subject merged in GitBook

Author: dgibbs64

code-standards/commands.md

@@ -1,14 +1,5 @@
 # Commands
 
-Within LInuxGSM there are many commands that a user will run to complete tasks such as start, stop, monitor, and details. Command scripts are stored will all other modules and are always named something like `command_install.sh`.
+Within LinuxGSM there are many commands that a user will run to complete tasks such as start, stop, monitor, and details. Command scripts are stored with all other modules and are always named something like `command_install.sh`.
 
-Here are the command functions you might need to alter when adding a new server:
-
-* command\_install.sh - Server installation must work properly
-* command\_update.sh - if the given game supports updates (might required to add a file for that matter, for now, we use to add a single file for install and update, like for TeamSpeak 3).
-* command\_details.sh - Server details need to be displayed properly
-* command\_monitor.sh & monitor\_gsquery.sh, query\_gsquery.py & query\_gsquery.py - You'll need to read carefully and understand this code before altering it.
-* core\_getopt.sh - You will define available commands in this one, displayed when the user runs `./gameserver` without an argument. Either use an existing opt or make a new one if needed.
-* command\_start.sh & command\_stop.sh - Of course, your server needs to be able to start and stop properly.
-* command\_debug.sh & command\_console.sh - Those commands usually work out of the box, but might require some more work. If not using tmux, then console should be disabled for this server in core\_getopt.sh.
-* info\_config.sh - You might need to read variables out of configuration files such as Rcon information in the case of Squad.
+Some game servers may require bespoke commands to complete tasks. Examples of this include Teamspeak 3 and Unreal Tournament 2004. Take a look at the `core_getopts.sh` module for examples of how to add commands.

code-standards/functions.md

@@ -1,30 +1,29 @@
 # Functions
 
-Functions are groupings of code that complete a task \(function\). These functions can be called upon anywhere within the code. Creating a function prevents having to replicat the same code over and over.
+Functions are groupings of code that complete a task (function). These functions can be called upon anywhere within the code. Creating a function prevents having to replicate the same code over and over.
 
 ## LinuxGSM Functions
 
-All functions within LinuxGSM begin with an prefix `fn_` and should be descriptive of what the function is doing. Words are separated by an underscore `_`. 
+All functions within LinuxGSM begin with the prefix `fn_` and should be descriptive of what the function is doing. Words are separated by an underscore `_`.
 
-For LinuxGSM development, it is important that developers understand what a function does which is why all function names must describes the propose of the function. A longer function name that describes the function is prevered over a short one that does not. 
+For LinuxGSM development, it is important that developers understand what a function does which is why all function names must describe the purpose of the function. A longer function name that describes the function is preferred over a short one that does not.
 
 ### Examples
 
-```text
+```
 fn_stop_graceful_cmd
 ```
 
-```text
+```
 fn_update_ts3_dl
 ```
 
 ### Syntax
 
 All functions should be formatted with the following syntax.
 
-```text
+```
 fn_function_name(){
     code
 }
 ```
-

code-standards/modules.md

@@ -6,21 +6,21 @@ Modules are individual bash scripts containing code and functions that complete
 
 A command will call upon modules to complete various command tasks. Modules are normally created if a task needs to be called upon by multiple commands, or as a logical way to split large commands and modules into smaller sub-modules.
 
-Modules are located in the `functions` directory,
+Modules are located in the `modules` directory,
 
-```text
-lgsm/functions
+```
+lgsm/modules
 ```
 
 ### Module Groups
 
-Modules are split into logical groups depending upon the type of task is being carried out.
+Modules are split into logical groups depending on the type of task being carried out.
 
 * alert – Sending alert notifications
 * check – completes checks before a command runs.
 * command – the command module that runs specific command tasks.
 * core – core modules that are required to run LinuxGSM.
-* fix – apply game server specific fixes to allow the game server to run correctly.
+* fix – apply game server-specific fixes to allow the game server to run correctly.
 * info – gathers info from sources such as the OS and game server.
 * install - modules related to installation
 * mods – handles game server mods
@@ -41,7 +41,7 @@ Core modules handle vital are required by LinuxGSM. These include download, geto
 
 Modules will launch in sequence as they are required by commands. The following modules will normally run in the following order when a command is executed:
 
-```text
+```
 core
 command
 check
@@ -52,7 +52,7 @@ It is possible to see the order that modules run by enabling `./gameserver dev`.
 
 Example output of `./gameserver stop`
 
-```text
+```
 + core_functions.sh
 ++ core_legacy.sh
 ++ core_messages.sh
@@ -83,14 +83,13 @@ Example output of `./gameserver stop`
 
 ## How Modules are Called
 
-In bash to call another bash script the `source` command is used. However, in LinuxGSM this is handled by the `core_functions.sh` module. This allows LinuxGSM automatically download a module the first time it is used then call the script.
+In bash to call another bash script, the `source` command is used. However, in LinuxGSM this is handled by the `core_modules.sh` module. This allows LinuxGSM to automatically download a module the first time it is used and then call the script.
 
 To call a module simply add the name of the module file e.g `info_config.sh` and the module will be called. If a new module is being added it must be added to the list of modules in `core_functions.sh` like so.
 
-```text
+```
 info_config.sh(){
 functionfile="${FUNCNAME}"
 fn_fetch_function
 }
 ```
-

getting-started/adding-a-new-game-server.md

@@ -24,11 +24,11 @@ Some common variables that will need updating:
 * Game Server Details `gamename` , `engine`, `glibc`.
 * Various directory and config variables.
 
-### Add the new server to serverlist.csv
+## Add the new server to serverlist.csv
 
 Add the new server details to `serverlist.csv` as well as add any dependency requirements to all the distro csv files found in `lgsm/data` directory.
 
-### Add any fixes to a fix file
+## Add any fixes to a fix file
 
 Some game servers require alterations before they can start common examples include:
 
@@ -44,31 +44,31 @@ If this is required a fix module will need to be created.
 3. Add the module to `fix.sh`
 4. Add the fix to `core_modules.sh` list
 
-### Server Querying
+## Server Querying
 
 Game servers can often be queried to check the server is running and return useful info. LinuxGSM uses gsquery.py to complete simple pings and [gamedig](https://github.com/gamedig/node-gamedig) to get detailed info returned in json format. 
 
 Most game servers use the valve protocol for allowing queries, however, others are available. Look for any developer documentation to try and find out if querying is supported. 
 
 Use the `query-raw` command to assist in testing the querying of the new game server. 
 
-### Stop Mode
+## Stop Mode
 
 Game servers will be able to gracefully exit using various methods. Figure out the method the new game server uses. See [stop mode](https://docs.linuxgsm.com/features/stop-mode).
 
-### Glibc Version
+## Glibc Version
 
 Most game servers require a minimum glibc version. Use the `detect-glibc` command to find out the minimum glibc version required.
 
-### Details
+## Details
 
 Various game server info will need to be parsed from game server configs or variables. Use the info\_\*.sh modules to add this info. 
 
-### Custom Updater
+## Custom Updater
 
 Not all game servers use SteamCMD. If this is the case a custom update module will need to be created. There are a number of examples in the code that can be used as a baseline.
 
-Custom Commands
+## Custom Commands
 
 Some game servers may require bespoke commands to complete tasks. Examples of this include Teamspeak 3 and Unreal Tournament 2004. Take a look at the `core_getopts.sh` module for examples of how to add commands.