Getting Started (Addons) - Revision history

Drakinite: /* Metadata (info.json) */

2024-12-06T04:49:02Z

Metadata (info.json)

← Older revision		Revision as of 04:49, 6 December 2024
Line 101:		Line 101:
	\| no*		\| no*
	\| The minimum compatible version of MediaMonkey for your addon. Please consult [[Methods_Added_Post_5.0]] to view whether your addon is incompatible with older versions of MediaMonkey.		\| The minimum compatible version of MediaMonkey for your addon. Please consult [[Methods_Added_Post_5.0]] to view whether your addon is incompatible with older versions of MediaMonkey.
			\|-
			\| maxAppVersion
			\| no
			\| The maximum compatible version of MediaMonkey for your addon. If this field is specified, then MediaMonkey versions newer than the one specified will not allow an installation of the addon. Useful if, for example, a newer version of MediaMonkey makes the addon not necessary to install or breaks compatibility.
	\|-		\|-
	\| type		\| type

2024-03-06T18:06:02Z

MediaMonkey folder structure

← Older revision		Revision as of 18:06, 6 March 2024
Line 170:		Line 170:
	** '''skin''' - Contains basic skin definitions, mostly a set of LESS files (an extension to CSS). See http://lesscss.org for more information.		** '''skin''' - Contains basic skin definitions, mostly a set of LESS files (an extension to CSS). See http://lesscss.org for more information.
	*** '''icon''' - Contains all the icons used by MM. They are in SVG format in order to scale nicely to any display resolution. As anything else, they can be easily replaced by any Addon (skin or script).		*** '''icon''' - Contains all the icons used by MM. They are in SVG format in order to scale nicely to any display resolution. As anything else, they can be easily replaced by any Addon (skin or script).
	** '''skins''' - Subfolders contain individual skins, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different looks of MM. Unlike layouts, this is supposed to mainly modify colors, fonts, icons, etc. See [[~~Skinning~~]] for more information.		** '''skins''' - Subfolders contain individual skins, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different looks of MM. Unlike layouts, this is supposed to mainly modify colors, fonts, icons, etc. See [[Skinning_Guide]] for more information.

	Filetypes that can be overridden:		Filetypes that can be overridden:

2023-08-16T12:58:07Z

Adding actions to menus

2022-10-03T00:49:04Z

UI Elements & Controls

← Older revision		Revision as of 00:49, 3 October 2022
Line 636:		Line 636:

	''More coming soon''		''More coming soon''

			<!-- todo: data-control-class and data-init-params -->

2022-09-14T18:57:49Z

Addon Config

← Older revision		Revision as of 18:57, 14 September 2022
Line 515:		Line 515:
	this.config.option1 = UI.chbOption1.controlClass.checked;		this.config.option1 = UI.chbOption1.controlClass.checked;
	this.config.option2 = UI.chbOption2.controlClass.checked;		this.config.option2 = UI.chbOption2.controlClass.checked;
	app.setValue('myAddon_config', this.~~state~~);		app.setValue('myAddon_config', this.config);
	}		}
	}		}

2022-05-25T16:38:19Z

Metadata (info.json)

← Older revision		Revision as of 16:38, 25 May 2022
Line 124:		Line 124:
	\| installScript		\| installScript
	\| no		\| no
	\| The filename of your addon's install script. The script will run once when the addon is being installed.		\| The filename of your addon's install script. The script will run once when the addon is being installed. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

	\|-		\|-
	\| uninstallScript		\| uninstallScript
	\| no		\| no
	\| The filename of your addon's uninstall script. The script will run once when the addon is being uninstalled.		\| The filename of your addon's uninstall script. The script will run once when the addon is being uninstalled. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.
	\|-		\|-
	\| files		\| files

2022-05-25T16:36:56Z

Packaging a Plugin

← Older revision		Revision as of 16:36, 25 May 2022
Line 602:		Line 602:
	"uninstallScript": "uninstall.js"		"uninstallScript": "uninstall.js"
	</syntaxhighlight>		</syntaxhighlight>
	The install script will run during installation and uninstall script will run after uninstallation.		The install script will run during installation and uninstall script will run after uninstallation.

			Both will run inside the main window, allowing full access to the UI. Additionally, the variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

	=Accessing the main window object from other windows=		=Accessing the main window object from other windows=

2022-05-01T17:08:29Z

Added icon stuff

@@ Line 611: / Line 611: @@
 If you assign a property or method to "app", you will need to do this to get the version of it that is attached to the main window.
 <syntaxhighlight lang="js">app.dialogs.getMainWindow().getValue('app').myObject.myMethod();</syntaxhighlight>
 ''More coming soon''

2022-04-30T02:02:02Z

Important tips

← Older revision		Revision as of 02:02, 30 April 2022
Line 258:		Line 258:

	* '''Do not spam console.log''' in your final addon that's distributed to users. While developing it, it is completely okay to use it as much as you want! However, the JavaScript console.log function is relatively computationally expensive, so if it spams logs, then it will degrade performance. If it just logs occasionally, for debugging purposes, it's okay. Just don't overdo it.		* '''Do not spam console.log''' in your final addon that's distributed to users. While developing it, it is completely okay to use it as much as you want! However, the JavaScript console.log function is relatively computationally expensive, so if it spams logs, then it will degrade performance. If it just logs occasionally, for debugging purposes, it's okay. Just don't overdo it.

			* To avoid breaking for...in loops, do not add functions to Array.prototype with the syntax <code>Array.prototype.func = function () {}</code>. Details here: https://www.ventismedia.com/mantis/view.php?id=18145

	=Actions, Hotkeys & Menus=		=Actions, Hotkeys & Menus=

2022-04-30T01:57:34Z

Metadata (info.json) #19010

← Older revision		Revision as of 01:57, 30 April 2022
Line 142:		Line 142:
	\| showRestartPrompt		\| showRestartPrompt
	\| no		\| no
	\| Default is "true". If "~~false~~", ~~installing~~ the ~~addon~~ will ~~not trigger MediaMonkey 5~~.0.~~3+ to~~ prompt ~~the user for~~ a restart. <u>Must be a string "true~~" or "~~false"; not ~~a boolean~~.</u>		\| Default is "true". Tells MediaMonkey whether to prompt a user for a restart. </br> Possible values: "true", "false", "install", and "uninstall". </br> If "true", MM will prompt the user for a restart on both install and uninstall. </br> If "install", MM will only prompt on install. </br> If "uninstall", MM will only prompt on uninstall. </br> If "false", neither installing nor uninstalling will prompt a restart. </br> <u>Must be a string if provided. Boolean true/false is not supported.</u>
	\|}		\|}