Addons - Revision history

Ibot3 at 11:45, 15 February 2020

2020-02-15T11:45:14Z

Ibot3: /* Addon Folder */

2019-01-21T17:04:52Z

Addon Folder

Ibot3: /* Addon Folder */

2018-01-16T14:21:14Z

Addon Folder

Ibot3 at 09:20, 21 May 2017

2017-05-21T09:20:17Z

Ibot3 at 09:19, 21 May 2017

2017-05-21T09:19:30Z

Ibot3 at 09:16, 21 May 2017

2017-05-21T09:16:15Z

Ibot3 at 09:10, 21 May 2017

2017-05-21T09:10:15Z

Ibot3 at 08:54, 21 May 2017

2017-05-21T08:54:41Z

Ibot3 at 08:54, 21 May 2017

2017-05-21T08:54:08Z

Ibot3 at 08:50, 21 May 2017

2017-05-21T08:50:00Z

← Older revision		Revision as of 11:45, 15 February 2020
Line 1:		Line 1:
−	This article explais, how to create an addon for GExtension.	+	This article explais how to create an addon for GExtension.

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

@@ Line 24: / Line 24: @@
 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 a installed.txt in the main addon folder, containing the date of the installation and the steamid64 of the user who ran it.
+*'''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]]

@@ Line 23: / Line 23: @@
 == 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".
+*'''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(). The process will create a installed.txt in the main addon folder, containing the date of the installation and the steamid64 of the user who ran it.
+*'''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 a 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()
+*'''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]]

@@ Line 16: / Line 16: @@
   [[Addons:Theme|/themes]]
-The meaning and function of those folders are explained below. Please try to imitate the folder structure of the GExtension core files.
+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 ===

@@ Line 26: / Line 26: @@
 *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(). The process will create a 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()
 [[Category:Addons]]

@@ Line 7: / Line 7: @@
 That's your main addon folder, where all files of your addon should be in. Additionally, you can create the following subfolders:
-  /api
+  [[Addons:API|/api]]
   /assets
-  /language
+  [[Addons:Language|/language]]
-  /main
+  [[Addons:Main|/main ]]
-  /pages
+  [[Addons:Page|/pages]]
-  /request
+  [[Addons:Request|/request]]
-  /settings
+  [[Addons:Setting|/settings]]
-  /themes
+  [[Addons:Theme|/themes]]
 The meaning and function of those folders are explained below. Please try to imitate the folder structure of the GExtension core files.

@@ Line 109: / Line 109: @@
 All themes must be a PHP file ending with ".css.php". To process the file it's necessary to add the following line to the code:
   header('Content-type: text/css');
-The GET parameter "color" contains the current style color if you want to use it.
+The GET parameter "color" contains the current style color ('#12345' will be '12345') if you want to use it.
 == Working In Progress ==

@@ Line 19: / Line 19: @@
 === Extending Existing Pages ===
-It's possible to extend existing files. If there are two files with hte 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.
+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 ==

← Older revision		Revision as of 08:50, 21 May 2017
Line 104:		Line 104:
	</pre>		</pre>

		+	== Section: themes ==
		+	=== General and Name ===
		+	All themes must be a PHP file ending with ".css.php". To process the file it's necessary to add the following line to the code:
		+	header('Content-type: text/css');
		+	The GET parameter "color" contains the current style color if you want to use it.

	== Working In Progress ==		== Working In Progress ==