This article will lead you through the installation process of GExtension.

== Web ==
First, you have to install the GExtension webpanel (GMOD Web).

# Download the installation files from [https://www.gmodstore.com/market/view/2899/download GmodStore]
# Edit config.php</li>
#* '''Protocol''': 'http' or 'https'. Only use 'https' if you have a valid SSL certificate.
#* '''SteamAPI''': Key: Get your API Key from [http://steamcommunity.com/dev/apikey Steam]
#* '''Timezone''': Select the correct timezone from [http://php.net/manual/en/timezones.php this site]
#* '''MySQL''': Insert ''IP'', ''port'', ''user'', ''password'' and ''database''
#* '''SMTP''' (optional): Insert ''mailserver'', ''port'', ''username'', ''password'', ''alias'', ''security'' and ''method''. You can use [https://outlook.live.com outlook.com] if you do not have your own mailserver.
# Upload the files to your webserver</li>
# '''(LINUX, self hosted)''' Set directory permissions: Your webserver needs read/write permissions for every GExtension file or folder. (Commands may differ per system)

For default PHP:
chown -R www-data:www-data /path/to/gextension/
chmod -R 770 /path/to/gextension/

For PHP FastCGI/FPM:
chown -R <CGI-USER>:www-data /path/to/gextension/
chmod -R 770 /path/to/gextension/

# Open the directory on your webserver using a browser
# Press '''"Retrieve"''' to get your license
# Press '''"Start"'''

===Troubleshooting===
[[Troubleshooting]]

== Lua ==
Attention: Your players may lose their groups if you do not follow the instructions under "Groups and Bans"

After installing the web part, you can now install the Lua addon.
#Open the GExtension webpanel (GMOD Web) with your webbrowser
#Click on the '''bullhorn (further named "Admin") -> Settings -> Update'''
#Click on the "Lua" button and save the ZIP file
#Extract the files to a '''local''' folder and navigate to ''"gextension/lua/gextension/config/"''
#Edit ''sh_config.lua'' to your needs. Required: WebURL
#Edit ''sv_config.lua'' and insert your MySQL data (same that you used for GMOD Web)
#Upload the folder into your server's addon folder
#[[MySQL|Install tMySQL or MySQLoo]]
#Restart your server and connect

The Lua installation is now finished and you should see that GExtension has connected to the database in the console.
But to work correctly, you now '''need to assign your server to a serverbundle'''.
#Open GMOD Web with your webbrowser
#Navigate to '''Admin -> Settings -> Servers'''
#Create a new serverbundle with a fitting name (for example "TTT") and select your server
#After five seconds, you can see in the console, that the server found the bundle

===Groups and Bans===
Go to '''Admin -> Settings -> Groups''' and create all groups you have in GMOD with the EXACT SAME name.
====Import users/bans from ULX or ServerGuard====
Make these steps before players connect to your server.
[[Import:ULX-ServerGuard]]

===Troubleshooting===
[[Troubleshooting#Lua]]

Installation

2020-04-04T10:17:12Z

Ibot3: /* Web */

This article will lead you through the installation process of GExtension.

== Web ==
First, you have to install the GExtension webpanel (GMOD Web).

# Download the installation files from [https://www.gmodstore.com/market/view/2899/download GmodStore]
# Edit config.php</li>
* '''Protocol''': 'http' or 'https'. Only use 'https' if you have a valid SSL certificate.
* '''SteamAPI''': Key: Get your API Key from [http://steamcommunity.com/dev/apikey Steam]
* '''Timezone''': Select the correct timezone from [http://php.net/manual/en/timezones.php this site]
* '''MySQL''': Insert ''IP'', ''port'', ''user'', ''password'' and ''database''
* '''SMTP''' (optional): Insert ''mailserver'', ''port'', ''username'', ''password'', ''alias'', ''security'' and ''method''. You can use [https://outlook.live.com outlook.com] if you do not have your own mailserver.
# Upload the files to your webserver</li>
# '''(LINUX, self hosted)''' Set directory permissions: Your webserver needs read/write permissions for every GExtension file or folder. (Commands may differ per system)

For default PHP:
chown -R www-data:www-data /path/to/gextension/
chmod -R 770 /path/to/gextension/

For PHP FastCGI/FPM:
chown -R <CGI-USER>:www-data /path/to/gextension/
chmod -R 770 /path/to/gextension/

# Open the directory on your webserver using a browser
# Press '''"Retrieve"''' to get your license
# Press '''"Start"'''

===Troubleshooting===
[[Troubleshooting]]

== Lua ==
Attention: Your players may lose their groups if you do not follow the instructions under "Groups and Bans"

After installing the web part, you can now install the Lua addon.
#Open the GExtension webpanel (GMOD Web) with your webbrowser
#Click on the '''bullhorn (further named "Admin") -> Settings -> Update'''
#Click on the "Lua" button and save the ZIP file
#Extract the files to a '''local''' folder and navigate to ''"gextension/lua/gextension/config/"''
#Edit ''sh_config.lua'' to your needs. Required: WebURL
#Edit ''sv_config.lua'' and insert your MySQL data (same that you used for GMOD Web)
#Upload the folder into your server's addon folder
#[[MySQL|Install tMySQL or MySQLoo]]
#Restart your server and connect

The Lua installation is now finished and you should see that GExtension has connected to the database in the console.
But to work correctly, you now '''need to assign your server to a serverbundle'''.
#Open GMOD Web with your webbrowser
#Navigate to '''Admin -> Settings -> Servers'''
#Create a new serverbundle with a fitting name (for example "TTT") and select your server
#After five seconds, you can see in the console, that the server found the bundle

===Groups and Bans===
Go to '''Admin -> Settings -> Groups''' and create all groups you have in GMOD with the EXACT SAME name.
====Import users/bans from ULX or ServerGuard====
Make these steps before players connect to your server.
[[Import:ULX-ServerGuard]]

===Troubleshooting===
[[Troubleshooting#Lua]]

Installation

2020-04-04T10:15:19Z

Ibot3: /* Web */

Donations:Packages

2020-03-18T17:37:14Z

Ibot3: /* Rewards */

Navigate to '''Admin -> Settings -> Donations -> Packages''' to create a package.

==General==
*Description
**This will be displayed as information for the package. We recommend to use "Unordered List".
*Serverbundle
**The bundle for which this package is for. Rewards will apply to all servers in this bundle.
*Price
**Custum Price: The user can decide how much to pay. In this case, the price will be the minimum amount.
*Days
**The duration of the package.
*Rebuyable
**Can this package get bought if the user already has an active instance of this package?
*Category
**Group multiple packages to make it easier to find a package.

==Rewards==
Assign rewards to the package here. Some further explainations:
*'''Groups''':
**Assign a group for the user for each bundle. You can decide to either return to the old groups, return to custom groups or do nothing on expiration.
*'''Teamspeak''':
**To assign a servergroup, just insert the name of it. You may decide to remove the group on expiration.
**To create a channel for the user, you need the ID of the parent channel and the name of an channel admin group. You may decide to remove the channel on expiration. You can also prevent to create a new channel if the user already owns a channel. The existing channel will be extended in this case. See [[Teamspeak]] for more information.
*'''Console Command and Custom Lua''':
**Take a look at the question marks on the right to get a list of available string replacements.
**''"executed directly (All Servers)"'': The command/code is executed once on each server as soon as the player connects (or instant if the player is connected)
**''"executed directly (One Server)"'': The command/code is executed on the first server the player connects to (or instant if the player is connected)
**''"executed on connect/player spawn"'': The command/code is executed whenenver the player connects/spawns
**''"executed on package expiration"'': The command/code is executed once on each server after package expiration
===Example how to create a "premium" status without groups===
1. Set the following code as reward for "Custom Lua (Connect)":
PLAYER:SetNWInt("gex_premium", 1)
2. Now you are able to check the "premium" status in any Lua script with:
if PLAYER:GetNWInt("gex_premium", 0) == 1 then
Please note that "PLAYER" in number 2 may '''differs in every script''' (sometimes ply). You can also use '''LocalPlayer()''' if you are on a clientside script.

==Extra==
'''Upgrade'''
*If the user owns a package mentioned in this list and buys the current one, the old package will be disabled and the remaining days will be added to the new one.
'''Not Compatible With / Disable after buying'''
*Description in the panel

Donations:Packages

2020-03-18T17:36:18Z

Ibot3: /* Rewards */

Navigate to '''Admin -> Settings -> Donations -> Packages''' to create a package.

==General==
*Description
**This will be displayed as information for the package. We recommend to use "Unordered List".
*Serverbundle
**The bundle for which this package is for. Rewards will apply to all servers in this bundle.
*Price
**Custum Price: The user can decide how much to pay. In this case, the price will be the minimum amount.
*Days
**The duration of the package.
*Rebuyable
**Can this package get bought if the user already has an active instance of this package?
*Category
**Group multiple packages to make it easier to find a package.

==Rewards==
Assign rewards to the package here. Some further explainations:
*Groups:
**Assign a group for the user for each bundle. You can decide to either return to the old groups, return to custom groups or do nothing on expiration.
*Teamspeak:
**To assign a servergroup, just insert the name of it. You may decide to remove the group on expiration.
**To create a channel for the user, you need the ID of the parent channel and the name of an channel admin group. You may decide to remove the channel on expiration. You can also prevent to create a new channel if the user already owns a channel. The existing channel will be extended in this case. See [[Teamspeak]] for more information.
*Console Command and Custom Lua:
**Take a look at the question marks on the right to get a list of available string replacements.
**"executed directly (All Servers)": The command/code is executed once on each server as soon as the player connects (or instant if the player is connected)
**"executed directly (One Server)": The command/code is executed on the first server the player connects to (or instant if the player is connected)
**"executed on connect/player spawn": The command/code is executed whenenver the player connects/spawns
**"executed on package expiration": The command/code is executed once on each server after package expiration
===Example how to create a "premium" status without groups===
1. Set the following code as reward for "Custom Lua (Connect)":
PLAYER:SetNWInt("gex_premium", 1)
2. Now you are able to check the "premium" status in any Lua script with:
if PLAYER:GetNWInt("gex_premium", 0) == 1 then
Please note that "PLAYER" in number 2 may '''differs in every script''' (sometimes ply). You can also use '''LocalPlayer()''' if you are on a clientside script.

==Extra==
'''Upgrade'''
*If the user owns a package mentioned in this list and buys the current one, the old package will be disabled and the remaining days will be added to the new one.
'''Not Compatible With / Disable after buying'''
*Description in the panel

Discord

2020-03-12T16:25:35Z

Ibot3: /* Roles */

Letting GExtension communicate with your discord guild requires you to create an application and add a bot to your guild.

Every user that wants to use the synchronization must set its '''discord username''' in the '''profile settings'''. This can be done at any time.

==Setup==
#Go to the [https://discordapp.com/developers/applications/ Discord Developer Portal] and create a new application. As name you can choose something like ''"GExtensionBot"'' or similar.
#After creating the application, navigate to the ''Bot'' tab and click the ''Add bot'' button.
#On your GExtension web-panel, navigate to '''Admin -> Settings -> Discord''' and insert the required data:
##The guild/server ID can be retrieved by following [https://support.discordapp.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID- this guide].
##The application client ID can be found in the ''General information'' tab of the application that we just created.
##The bot token can be found in the ''Bot'' tab after clicking ''Click to Reveal Token''.
#Click ''Save''
#Add the bot to your server by clicking ''Add bot to guild''
#A new role has been created in your guild, which has the same name as your bot. Go to '''Discord server settings -> Roles''' and move the role (e.g. ''"GExtensionBot''") to the highest position.

If you did all steps correctly, you should now find your discord guild in the ''Servers'' section. You may need to enable widgets in the Discord server settings for the widget to work.

==Roles==
Roles can be given through a reward of a donation package or as synchronization of a GExtension group. To establish a synchronization, follow these steps:
#Navigate to '''Admin -> Settings -> Groups -> Edit -> Discord Synchronization'''
#Insert the ID of the role for the group in the specified bundle. For example the ID for the role "TTT-Moderator" in the TTT bundle of the group Moderator.

The synchronization of a user will be checked on the following events:
*Everytime the '''discord username''' was changed in the profile settings
*Everytime the groups of the user were changed

==FAQ==
'''How do I get the ID of a role?'''
*Go to any channel and send a message with the content "'''\@[RoleName]'''" with replacing ''[RoleName]'' with the name of the role. For example '''\@Moderator'''. You will get something like '''<@&552888644130701312>'''. In this case, '''552888644130701312''' is the desired role id. '''Please note:''' "Allow anyone to @mention this role" must be enabled on the targeted role for this process to work.

Addons

2020-02-15T11:45:14Z

Ibot3:

This article explais how to create an addon for GExtension.

See [[Code Structure]] for information about how GExtension is coded. '''IMPORTANT!'''

== Folder Structure ==
The folder structure is similar to the one of Garry's Mod. First, you should create a folder: '''"addons/[your-addon]"'''

That's your main addon folder, where all files of your addon should be in. Additionally, you can create the following subfolders:
[[Addons:API|/api]]
/assets
[[Addons:Language|/language]]
[[Addons:Main|/main ]]
[[Addons:Page|/pages]]
[[Addons:Request|/request]]
[[Addons:Setting|/settings]]
[[Addons:Theme|/themes]]

The meaning and function of those folders are explained in extra articles, '''click on a subfolder to get there'''. Please try to imitate the folder structure of the GExtension core files.

=== Extending Existing Pages ===
It's possible to extend existing files. If there are two files with the same name, for example "pages/search.php" and "addons/[your-addon]/pages/search.php", the original file will be included and the addon file afterwards. This can be used to extend for example pages or language files.

== Addon Folder ==
Additionaly to the subfolders named above, the main addon folder can contain some more files:
*'''addon.txt''': Optional. Contains a json object with information about the addon, important at the moment are, "author" and "version".
*'''install.php''': Optional. If existent, gives the user the ability to run a one-time setup to complete the addon installation. Possible by navigating to '''Admin -> Settings -> Addons'''. Must contain a function Install() that returns true/false. The process will create an file called named installed.txt in the main addon folder, containing the date of the installation and the steamid64 of the user who ran it.
*'''uninstall.php''': Optional. If existent, this script will be run when the addon gets uninstalled (by navigating to '''Admin -> Settings -> Addons'''). Should be used to remove any leftovers. Must contain a function Uninstall() that returns true/false.

[[Category:Addons]]

MySQL

2020-02-01T14:54:47Z

Ibot3:

To allow a connection to your database, you will need to install a MySQL module on your Garry's Mod server.

Please note that you have to use different files, depending on the OS of your Garry's Mod server (Windows/Linux).

==Installation==
#Download this file and upload it to '''garrysmod/lua/bin''' (create it if it doesn't exist):
#*Windows: [https://github.com/FredyH/MySQLOO/releases/download/9.6.1/gmsv_mysqloo_win32.dll gmsv_mysqloo_win32.dll]
#*Linux: [https://github.com/FredyH/MySQLOO/releases/download/9.6.1/gmsv_mysqloo_linux.dll gmsv_mysqloo_linux.dll]

If you are not allowed to upload dll files, ask your hoster.

For Windows, the [https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads Visual Studio redistributable for 2019] may be required.

MySQL

Ibot3: /* Other */

Welcome to the GExtension Wiki.

== Getting started ==
===Installation===
* [[Installation]]
* [[Troubleshooting]]
===Import===
* [[Import:Prometheus|Prometheus]]/[[Import:SDonate|SDonate]] Import
* [[Import:ULX-ServerGuard|ULX/ServerGuard Import]]
* [[Import:GBan|GBan Import]]
* [[Import:AWarn2|AWarn2 Import]]
===Donations===
* [[Donations:Payments|Payments]]
* [[Donations:Packages|Packages]]
* [[Donations:Administration|Administration]]
===Other===
* [[Groups]]
* [[Warnings]]
* [[Languages]]
* [[License]] (information and transfer to new webhost)
* [[Update]]

===For Developers===
* [[Addons]]
* [[Code Structure]]
* [[API]]