Description

Lone.Design Update Checker

In short

Do you use any Lone.Design plugins? This lightweight and free add-on will make sure you’ll never miss another update!

Although it won’t download the new versions of the plugins for you, it will let you know which of your Lone.Design plugins are up to date and which aren’t.

This happens every time you load/reload Lone Update Checker, when you load/reload another plugin, and on a pre-defined timer (every 30 minutes by default).

No permissions. No commands. No data stored. Just drop it into your plugin folder and you’re good to go:

Permissions

loneupdatechecker.blacklist

This permission is required for admins/moderators who would like to use the lone.blacklist command.

Admin Commands

lone.blacklist [add | remove | list | clear]

If you want to ignore a particular plugin and exclude it from the update check for whatever reason (both the regularly scheduled bulk check, and individual checks when a plugin loads/reloads), this command is you friend.

1. To add a plugin to the blacklist, use lone.blacklist add [full or partial name of the plugin, with or without .cs extension, lowercase/uppercase does NOT matter]
2. To remove a plugin from the blacklist, use lone.blacklist remove [full or partial name of the plugin, with or without .cs extension, lowercase/uppercase does NOT matter]
3. To see a rundown of all the plugins currently blacklisted, use lone.blacklist list
4. To clear the entire blacklist, first, use lone.blacklist clear – without any extra arguments. As a fail-safe precaution, you will be prompted to then type lone.blacklist clear [number] – if you don’t type the right number, clearing won’t proceed

All of those entries are stored in the config file (see below).

This command can be executed both from the server/RCON console or the client.

In the client, the player executing it must have the loneupdatechecker.blacklist permission.
When typing the command out in the chat, remember about putting a slash ( / ) before it. F1/server console requires no slash.

Configuration (oxide/config/LoneUpdateChecker.json)

{
    "Version": {
        "Major": 1,
        "Minor": 3,
        "Patch": 0
    },
    "CheckForUpdatesWhenPluginsLoad": true,
    "CheckForUpdatesPeriodically": true,
    "HowManyMinutesBetweenPeriodicalUpdates": 30,
    "Blacklist": ["PluginFilename1.cs", "PluginFilename2.cs", "PluginFilename3.cs"]
}

If you only want to check for updates when Lone Update Checker is loaded/reloaded (including when the server has just finished loading),  you can change “CheckForUpdatesPeriodically” to false.

If you leave it as true, you can also define how often the updates are performed. By default, it’s every 30 minutes, but you can make this timer longer if you’d like by changing the “HowManyMinutesBetweenPeriodicalUpdates” value. If you try to set it to less than 30 minutes, the plugin will automatically revert it to 30.

You can also disable checking for an update for a plugin that just loaded/reloaded by setting “CheckForUpdatesWhenPluginsLoad” to false.

Translation support (oxide/lang/en/LoneUpdateChecker.json)

If you’d like to help translate the plugin text into your native language, please let us know!

Future Additions Planned

• Add more sites to this update checker
• Add configuration option to announce in a discord channel when a plugin needs updating
• Additional hooks for developers
• An Extension version so that it can automatically stay updated when new patches are made

If you’re a Lone.Design Vendor

You need to make sure you have set up your product page correctly so your plugin can be discovered by the API.

Fill in your plugin SKU (Plugin Name) field with the exact same filename as your main plugin:

If you leave this field blank or it doesn’t match the filename of your plugin, the API won’t return any results for your product.

Add at least 1 entry in your product Changelog

You need to use the approved versioning scheme, e.g. major.minor.patch (like 1.0.0 or 1.3.37). It needs to be 3 positive numbers (no greater than 255) separated by a period.

If you don’t use this scheme, for instance, if you only use 1 or 2 numbers separated by periods, Lone Updates Checker will return the following message: YourPluginName.cs: ERROR! API returned an invalid version number.