☰

WME Utils - Bootstrap

Adds a bootstrap function for easier startup of wmeSdk, WazeWrap, and ScriptUpdateMonitor.

Verzia zo dňa 27.09.2024. Pozri najnovšiu verziu.

Tento skript by nemal byť nainštalovaný priamo. Je to knižnica pre ďalšie skripty, ktorú by mali používať cez meta príkaz // @require https://update.greatest.deepsurf.us/scripts/509664/1455326/WME%20Utils%20-%20Bootstrap.js

Autor
mapomatic a WazeDev
Verzia
2024.09.27.000
Vytvorené
22.09.2024
Aktualizované
27.09.2024
Veľkosť
2,7 KB
Licencia
GNU GPLv3

Usage:

// Add this to your userscript header:
// @require    https://update.greatest.deepsurf.us/scripts/509664/WME%20Utils%20-%20Bootstrap.js

// If using WazeWrap and/or its ScriptUpdateMonitor feature, be sure to also include this in the userscript header:
// @require    https://greatest.deepsurf.us/scripts/24851-wazewrap/code/WazeWrap.js

let wmeSdk; // A "global" variable to store your WmeSdk reference.

function init(sdk) { // sdk is passed to init (callback function) by bootstrap
    // Store the reference to the sdk
    wmeSdk = sdk;
    // The rest of your init code...
}

bootstrap({
    scriptName: 'My Script',
    scriptId: 'myScript',
    useWazeWrap: true,
    scriptUpdateMonitor: {
        scriptVersion: '1.0',
        downloadUrl: 'https://...',
        metaUrl: 'https://...',
        metaRegExp: /some regex/ 
    },
    init
});

The options object passed to bootstrap:

  • scriptName: The name of your script. Used in initializing the WME SDK and for ScriptUpdateMonitor alerts (if using WazeWrap.Alerts.ScriptUpdateMonitor)
  • scriptId: Used in initializing the WME SDK
  • useWazeWrap: OPTIONAL. Set to true if your script uses the WazeWrap library (you must still @require it in your script header). Must be set to true if using ScriptUpdateMonitor.
  • scriptUpdateMonitor: OPTIONAL. An object containing the following properties, only needed if using ScriptUpdateMonitor.
    • scriptVersion: The current version of your script.
    • downloadUrl: The download URL of your script.
    • metaUrl: OPTIONAL. A page containing script version information. Scripts on Greasy Fork do not need to use this.
    • metaRegExp: OPTIONAL. A regular expression that returns the script version from the metaUrl page. Scripts on Greasy Fork do not need to use this.
  • callback: A function to call once bootstrapping is completed. The WmeSdk object will be passed to the first argument to the function.