Description

PlayOn Scripts can override a variety of default auto-generated settings.

Overriding the default settings will make the script user experience friendlier by providing the user with additional information.

--[[Settings

--Lua code assigning any number of predefined global variables.

EndSettings]]--

Global Variables

  Name Description
Public method string name Name of the script in PlayOn (defaults to the script file name without the extension).
Public method string id Unique ID for the script.
Public method string description Friendly description of the script shown in PlayOn Settings.
Public method string version Version of the script shown in PlayOn Settings.
Public method string link URL to the script's website shown in PlayOn Settings.
Public method string apiversion One of the following versions of the API this script uses:
  1 - Legacy (default)
  2 - New w/ VFS/LoadDynamicVirtualFolder/CreatePlaybackDescriptor

Example 

--[[Settings
name = "My Awesome Script";
id = "MyAwesomeScript";
description = "My Über Awesome Script!  It just pwns!";
version = "1.2.3.4";
link = 'http://www.notarealsite.nars/myscript';
EndSettings]]--

See Also