Add few games support and update readme

README.md

@@ -27,6 +27,9 @@ Server table showing server information about the status, name, number of player
 - [Requirements 🏷️](#requirements-)
 - [Compatible servers 💻](#compatible-servers-)
 - [Install 🧰](#install-)
+- [Configuration 🔨](#configuration-)
+  - [Discord Configuration](#dicord-configuration)
+  - [TeamSpeak 3 Permissions](#teamspeak-3-permissions)
 - [Update 🛠️](#update-)
 - [Graphics 📷](#graphics-)
 - [Download from other sources 🔌](#download-from-other-sources-)
@@ -35,7 +38,8 @@ Server table showing server information about the status, name, number of player
 
 - [IPS Community Suite: 4.5 version](https://invisioncommunity.com/)
 - PHP 7.2+
-- [Bzip2](https://www.php.net/manual/en/book.bzip2.php) - Used for A2S Compressed responses
+- [Bzip2](https://www.php.net/manual/en/book.bzip2.php) - Used for A2S Compressed responses,
+- ❗❗ Unlocked external ports on the website server
 
 ## Compatible servers 💻
 
@@ -79,7 +83,29 @@ Server table showing server information about the status, name, number of player
 - Multi Theft Auto
 - Mumble Server
 - Natural Selection 2
+- Quake 2 Server
+- Quake 3 Server
+- Quake Live
+- Red Orchestra 2
+- Rust
+- San Andreas Multiplayer
+- 7 Days to Die
+- The Ship
+- Squad
+- StarMade
 - Teamspeak 3
+- Teeworlds Server
+- Terraria
+- Team Fortress 2
+- Tibia
+- Tshock
+- Unreal 2
+- Unturned
+- Unreal Tournament 3
+- Unreal Tournament 2004
+- Ventrilo
+- Warsow
+- World Opponent Network
 
 _In future versions, new servers will be added to the list._
 
@@ -91,6 +117,38 @@ _In future versions, new servers will be added to the list._
    ![Manual Upload](https://axendev.net/github/app/manual_upload.png)
 3. Select file **.tar** [from packet](https://github.com/aXenDeveloper/ips-app-serverlist/releases) and click install button
 
+## Configuration 🔨
+
+1. Go to: AdminCP -> Advanced Server List -> Servers -> **Create new**,
+2. First you have to choice a game in **Game**,
+3. Provide a custom name in **Custom name** for example: _JailBreak_,
+4. Provide a adress IP in **IP** for exampe: **145.239.16.78:27015**.  
+   ❗❗ Some servers like **TeamSpeak 3** require a **Query port**!
+5. Click **save**.
+
+### Discord configuration
+
+You have to configurate Discord Widget which will return a value:
+
+- name,
+- instant_invite,
+- presence_count
+
+To add a discord server you have to enter the widget ID in the **IP** field.
+
+If you want check return values from your server discord check from json file: `https://discordapp.com/api/guilds/{your ID widget form discord}/widget.json` for example: https://discordapp.com/api/guilds/720054040116854835/widget.json
+
+### TeamSpeak 3 Permissions
+
+If after adding TeamSpeak 3 server but it's still offline then check permissions for **guest** group:
+
+```
+b_virtualserver_info_view
+b_virtualserver_channelgroup_list
+b_virtualserver_client_list
+b_virtualserver_channel_list
+```
+
 ## Update 🛠️
 
 1. Go to: AdminCP -> System -> SITE FEATURES -> **Appliactions**,  

data/javascript.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <javascript app="axenserverlist">
- <file javascript_app="axenserverlist" javascript_location="front" javascript_path="controllers/axenserverlist" javascript_name="aXenServerList.js" javascript_type="controller" javascript_version="10003" javascript_position="1000050"><![CDATA[const COOKIE_AXENSERVERLIST_HIDE = 'aXenServerList_widget_hide';
+ <file javascript_app="axenserverlist" javascript_location="front" javascript_path="controllers/axenserverlist" javascript_name="aXenServerList.js" javascript_type="controller" javascript_version="10004" javascript_position="1000050"><![CDATA[const COOKIE_AXENSERVERLIST_HIDE = 'aXenServerList_widget_hide';
 const COOKIE_AXENSERVERLIST_SCROLL = 'aXenServerList_widget_scroll';
 const COOKIE_AXENSERVERLIST_FULLWIDTH = 'aXenServerList_widget_fullWidth';
 

data/lang.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <language>
- <app key="axenserverlist" version="10003">
+ <app key="axenserverlist" version="10004">
   <word key="__app_axenserverlist" js="0">(aXen) Advanced Server List</word>
   <word key="menutab__axenserverlist_icon" js="0">server</word>
   <word key="menutab__axenserverlist" js="0">Advanced Server List</word>
@@ -10,6 +10,7 @@
   <word key="axenserverlist_game" js="0">Game</word>
   <word key="axenserverlist_name" js="0">Custom name</word>
   <word key="axenserverlist_ip" js="0">IP</word>
+  <word key="axenserverlist_ip_desc" js="0">If your server is Discord then provide ID widget.</word>
   <word key="axenserverlist_owners" js="0">Owners</word>
   <word key="axenserverlist_statistics" js="0">Statistics URL</word>
   <word key="axenserverlist_tv" js="0">TV URL</word>

data/versions.json

@@ -2,5 +2,6 @@
     "10000": "1.0.0 Alpha 1",
     "10001": "1.0.0 Alpha 2",
     "10002": "1.0.0 Beta 1",
-    "10003": "1.0.0 Beta 2"
+    "10003": "1.0.0 Beta 2",
+    "10004": "1.0.0 Beta 3"
 }

dev/lang.php

@@ -10,6 +10,7 @@
 	'axenserverlist_game' => 'Game',
 	'axenserverlist_name' => 'Custom name',
 	'axenserverlist_ip' => 'IP',
+	'axenserverlist_ip_desc' => 'If your server is Discord then provide ID widget.',
 	'axenserverlist_owners' => 'Owners',
 	'axenserverlist_statistics' => 'Statistics URL',
 	'axenserverlist_tv' => 'TV URL',

setup/upg_10004/data.json

@@ -0,0 +1,24 @@
+{
+    "id": 10004,
+    "name": "1.0.0 Beta 3",
+    "steps": {
+        "queries": false,
+        "lang": true,
+        "theme": true,
+        "themeSettings": false,
+        "javascript": true,
+        "emailTemplates": false,
+        "hooks": false,
+        "acpSearchKeywords": false,
+        "settings": false,
+        "tasks": false,
+        "modules": false,
+        "widgets": false,
+        "whatsnew": false,
+        "customOptions": false,
+        "customRoutines": false
+    },
+    "forceMainUpgrader": false,
+    "forceManualDownloadNoCiC": false,
+    "forceManualDownloadCiC": false
+}

setup/upg_10004/javascript.json

@@ -0,0 +1,14 @@
+{
+    "files": {
+        "added": [],
+        "edited": [
+            "axenserverlist\/front\/controllers\/axenserverlist\/aXenServerList.js"
+        ],
+        "removed": []
+    },
+    "orders": {
+        "added": [],
+        "edited": [],
+        "removed": []
+    }
+}

setup/upg_10004/lang.json

@@ -0,0 +1,14 @@
+{
+    "normal": {
+        "added": [
+            "axenserverlist_ip_desc"
+        ],
+        "edited": [],
+        "removed": []
+    },
+    "js": {
+        "added": [],
+        "edited": [],
+        "removed": []
+    }
+}

setup/upg_10004/theme.json

@@ -0,0 +1,82 @@
+{
+    "html": {
+        "added": [],
+        "edited": [
+            "front\/servers\/footer",
+            "front\/servers\/more",
+            "front\/servers\/row",
+            "front\/widgets\/aXenServerListWidget"
+        ],
+        "removed": []
+    },
+    "css": {
+        "added": [],
+        "edited": [
+            "front\/widget.css"
+        ],
+        "removed": []
+    },
+    "resources": {
+        "added": [
+            "front\/icons\/arkse.png",
+            "front\/icons\/arma3.png",
+            "front\/icons\/bf1942.png",
+            "front\/icons\/bf2.png",
+            "front\/icons\/bf3.png",
+            "front\/icons\/bf4.png",
+            "front\/icons\/bfbc2.png",
+            "front\/icons\/bfh.png",
+            "front\/icons\/cod.png",
+            "front\/icons\/cod2.png",
+            "front\/icons\/cod4.png",
+            "front\/icons\/coduo.png",
+            "front\/icons\/codwaw.png",
+            "front\/icons\/conanexiles.png",
+            "front\/icons\/contagion.png",
+            "front\/icons\/cscz.png",
+            "front\/icons\/css.png",
+            "front\/icons\/dayz.png",
+            "front\/icons\/dayzmod.png",
+            "front\/icons\/gmod.png",
+            "front\/icons\/grav.png",
+            "front\/icons\/gta5m.png",
+            "front\/icons\/gtan.png",
+            "front\/icons\/hl2dm.png",
+            "front\/icons\/hurtworld.png",
+            "front\/icons\/insurgency.png",
+            "front\/icons\/jediacademy.png",
+            "front\/icons\/jedioutcast.png",
+            "front\/icons\/justcause2.png",
+            "front\/icons\/justcause3.png",
+            "front\/icons\/l4d.png",
+            "front\/icons\/l4d2.png",
+            "front\/icons\/mohaa.png",
+            "front\/icons\/mta.png",
+            "front\/icons\/mumble.png",
+            "front\/icons\/ns2.png",
+            "front\/icons\/quake2.png",
+            "front\/icons\/quake3.png",
+            "front\/icons\/quakelive.png",
+            "front\/icons\/redorchestra2.png",
+            "front\/icons\/rust.png",
+            "front\/icons\/samp.png",
+            "front\/icons\/sevendaystodie.png",
+            "front\/icons\/ship.png",
+            "front\/icons\/squad.png",
+            "front\/icons\/starmade.png",
+            "front\/icons\/teeworlds.png",
+            "front\/icons\/terraria.png",
+            "front\/icons\/tf2.png",
+            "front\/icons\/tibia.png",
+            "front\/icons\/tshock.png",
+            "front\/icons\/unreal2.png",
+            "front\/icons\/unturned.png",
+            "front\/icons\/ut2004.png",
+            "front\/icons\/ut3.png",
+            "front\/icons\/ventrilo.png",
+            "front\/icons\/warsow.png"
+        ],
+        "edited": [],
+        "removed": []
+    }
+}

sources/Servers/Servers.php

@@ -89,7 +89,29 @@ public function form(&$form)
       'mta' => 'Multi Theft Auto',
       'mumble' => 'Mumble Server',
       'ns2' => 'Natural Selection 2',
-      'teamspeak3' => "Teamspeak 3"
+      'quake2' => 'Quake 2 Server',
+      'quake3' => 'Quake 3 Server',
+      'quakelive' => 'Quake Live',
+      'redorchestra2' => 'Red Orchestra 2',
+      'rust' => 'Rust',
+      'samp' => 'San Andreas Multiplayer',
+      'sevendaystodie' => '7 Days to Die',
+      'ship' => 'The Ship',
+      'squad' => 'Squad',
+      'starmade' => 'StarMade',
+      'teamspeak3' => "Teamspeak 3",
+      'teeworlds' => 'Teeworlds Server',
+      'terraria' => 'Terraria',
+      'tf2' => 'Team Fortress 2',
+      'tibia' => 'Tibia',
+      'tshock' => 'Tshock',
+      'unreal2' => 'Unreal 2',
+      'unturned' => 'Unturned',
+      'ut3' => 'Unreal Tournament 3',
+      'ut2004' => 'Unreal Tournament 2004',
+      'ventrilo' => 'Ventrilo',
+      'warsow' => 'Warsow',
+      'won' => 'World Opponent Network'
     ), 'multiple' => FALSE)));
     $form->add(new \IPS\Helpers\Form\Text('axenserverlist_name', $this->name, TRUE));
     $form->add(new \IPS\Helpers\Form\YesNo('axenserverlist_name_default', $this->name_default, FALSE));