Installing packages

In the launcher

Open the Plugins page from the top left corner of the main page. The list on the left picks what is shown:

The catalog only offers packages that work with your version of LonelyIce and your system. The launcher reads the catalogs when it starts (or when you first open the page); Check for updates reads them again.

Language above the catalog shows only packages whose texts (chat, menus, quest and item names) are translated into the language you pick; Any language shows everything. Packages without texts of their own, like a database backend, are marked "any language" and always shown. The launcher remembers your choice.

To install a package:

1. Stop the server. Plugins can only change while it is off ("Stop the server: plugins change while it is off.").
2. Open Catalog and press Install next to the package. The packages it needs are installed with it.
3. Start the server. The databases and the game client follow on the next server start: the plugin's database changes are applied and its client patches are built then.

Each plugin row has buttons for what you can do with it:

Update all installs every available update of your enabled plugins at once. What happened is listed in the Events on the Overview tab.

An install is all or nothing: every package it needs is downloaded and checked first, and if anything fails on the way, nothing is changed ("Nothing was changed: the previous versions are back in place."). The launcher also refuses what would break your plugins, and says why:

• disabling or removing a plugin that others need ("… is needed by: …");
• installing or updating something that needs a disabled plugin: enable that one first;
• enabling a plugin whose own dependencies are missing, disabled or too old, or that conflicts with an enabled plugin;
• installing a package that conflicts with an installed plugin, in either direction.

A disabled plugin keeps the ids it gave to the spells, items and other game entries it adds, so enabling it again brings the same ones back. Only removing a plugin gives them up.

If your game folder already has a patch-<language>-4.MPQ that LonelyIce did not write, the server does not overwrite it: before it builds its own patch it renames that file to .bak (or .bak2, .bak3, … when that name is taken) and says so in the log.

When updates are waiting, the Plugins button on the main page shows their number and the Overview tab says "Plugin updates available", with a button that opens the Updates view.

Catalogs

A new install has one catalog, shown as LonelyIce catalog: the package catalog of this site, https://lonelyice.org/packages/index.json. Catalogs… at the bottom of the list on the left manages them:

• Add a catalog: type the web address of an index.json (https://…), or the path of a local index.json or of a folder that holds one, and press Add. Folder… picks a local folder.
• Disable keeps a catalog in the list without reading it; Remove deletes it from the list.
• Bring back the LonelyIce catalog appears when you removed it.

A catalog that cannot be read is skipped and marked; the others keep working. To make a catalog of your own, see Your own catalog; to put a package into this site's catalog, see Publishing a package.

From the command line

LonelyIce.exe --pkg available
LonelyIce.exe --pkg install lonelyice.qol
LonelyIce.exe --pkg update
LonelyIce.exe --pkg remove lonelyice.qol

list, enable and disable work the same way; --pkg available --locale ru lists only packages translated into that language. install takes several ids and an optional version range, written as in npm: lonelyice.qol@^1.2, [email protected], lonelyice.qol@">=1.0.0 <2.0.0" (quoted, because of the space and the < >). update without an id updates every enabled plugin.

Stop the server first here too: while it runs, install, update, remove, enable and disable stop at once with "the server is running on this plugins folder (…): stop it first". list and available always work. The full list is in the package manager and Command line.