Modules

Search…
Modules
Modules are individual bash scripts containing code and functions that complete specific tasks.
Modules may sometimes be referred to as function files or just functions are located in the functions directory and not be confused with bash functions. Modules have been named as such to avoid confusion.
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,
1
lgsm/functions
Copied!
Module Groups
Modules are split into logical groups depending upon the type of task is 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.
info – gathers info from sources such as the OS and game server.
install - modules related to installation
mods – handles game server mods
query – game server query modules
update – handles updating of game servers and LinuxGSM
Module Pointer
Some modules such as fix.sh and check.sh are made up of smaller tasks that are split up into sub-modules. Because of this, these modules become pointers for their sub-modules that will upon the sub-modules as required.
An example of this is when check.sh will be called within command_start.sh, it will automatically select which sub-module tasks are required and run them.
Core Modules
Core modules handle vital are required by LinuxGSM. These include download, getopt, messages, exit, trap
Module Order
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:
1
core
2
command
3
check
4
fix
Copied!
It is possible to see the order that modules run by enabling ./gameserver dev. Once enabled the module order will be saved in dev-debug-function-order.log
Example output of ./gameserver stop
1
+ core_functions.sh
2
++ core_legacy.sh
3
++ core_messages.sh
4
++ core_dl.sh
5
++ core_trap.sh
6
+ core_getopt.sh
7
+++ command_stop.sh
8
++++ check.sh
9
+++++ check_root.sh
10
+++++ check_tmuxception.sh
11
+++++ check_permissions.sh
12
+++++ check_system_dir.sh
13
+++++ check_logs.sh
14
+++++ check_deps.sh
15
++++++ info_distro.sh
16
+++++ check_config.sh
17
+++++ check_ip.sh
18
++++++ info_config.sh
19
++++++ info_parms.sh
20
+++++ check_status.sh
21
++++ info_config.sh
22
++++ check_status.sh
23
++++ check_status.sh
24
++++ check_status.sh
25
++++ check_status.sh
26
++++ core_exit.sh
Copied!
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.
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.
1
info_config.sh(){
2
functionfile="${FUNCNAME}"
3
fn_fetch_function
4
}
Copied!
Code Standards - Previous
Functions
Next - Code Standards
Exit Codes
Last modified 2yr ago
Copy link
Contents
How Modules are Called