Add-ons/Point of Interest System (POIS)/Sharing and point libraries

Lua add-on documentation: Point of Interest System (POIS) overview · Add-on hub · Contribute or update documentation

Sharing and point libraries

POIS shares points as encoded text. A player can export a selection for another player to import, while an add-on author can package a maintained collection as a point library.

Export and import

1. Open POIS with /pois.
2. Select Export, choose the points, and select Export Selected. All displayed points begin selected.
3. Copy the complete encoded text from the Export Output window.
4. The recipient selects Import, pastes the complete text, and confirms the import.

Use the windows rather than chat commands. Long export strings exceed the game's chat-input limit and can be silently truncated or corrupted. POIS retains its older large-text windows for this workflow because a native text field is also limited to 1,024 characters.

Import and export are deliberate clipboard operations. POIS requests no Internet permission and does not transmit points automatically. Treat shared text as data: keep an original copy until the recipient confirms that it imported successfully.

Library points may be included in an ordinary export. POIS converts them into collision-safe personal points so the recipient does not need the source library.

What a point library does

A point-library add-on supplies a curated encoded set to POIS. The library owns its point names and coordinates; users can change local visibility and color but cannot rename or delete the source entries. Disabling the library unloads its points. Rabbit Locations in Castle Atos is the catalog's first example.

For authors, a library package should depend on both sota-event-system-ses-addon and pois. Give it a permanent, globally distinctive library key. After SES starts, announce the encoded export and metadata:

SES.invoke("POIS.onLoadLibrary",
  LibraryKey, ScriptName, Version,
  CreatorName, Description, LibraryPointData)

On disable, remove it with:

SES.invoke("POIS.onUnloadLibrary", LibraryKey)

Create the points in POIS and use its export window to produce LibraryPointData; there is no need to hand-author the encoded format. The official Rabbit package registers its load after the SES start event and unloads on ShroudOnDisableScript.

POIS subscribes with SES's per-sender replay option. That lets POIS recover announcements from multiple already-running libraries after POIS itself reloads; library authors should use one stable key consistently for load and unload.

Library-author checklist

• Use a stable package slug and a separate stable library key.
• Declare SES and POIS as dependencies and load the library only after SES is ready.
• Export and test the complete point set on a clean installation.
• Supply a clear creator name, version, and description.
• Unload the same key when the script is disabled.
• Document the scene, purpose, maintenance source, and documented library version.

See also

• POIS overview
• Using points
• Rabbit Locations in Castle Atos
• SotA Event System (SES)