Leno Docs
LenoSpirit Pro

Installation

Install LenoSpirit Pro — add the resource, ensure it, set the staff permission, and let it save.

Installation ​

LenoSpirit Pro has no dependencies and no database.

1. Add the resource ​

Place the leno_spirit_pro folder in your server resources directory (for example inside a [leno] group).

2. Ensure it ​

Add to server.cfg:

cfg
ensure leno_spirit_pro

The start order doesn't matter. LenoSpirit Pro doesn't depend on any framework.

3. Set the staff permission ​

The menu and the staff commands (/spiritadmin, /spirittest) need an ACE permission:

cfg
add_ace group.admin leno_spirit.admin allow
add_principal identifier.license:YOUR_LICENSE group.admin

Default ACE string: leno_spirit.admin (Config.Permissions.admin). It is the same as the free version, so an existing line keeps working. The player toggle /spirit needs no permission.

To use your own staff system instead of ACE, override SpiritHooks.IsStaff (see Exports and Events).

4. Let the server write the config ​

The menu saves its settings into config.lua and keeps backups in data/backups/. The server process must be able to write both.

On hosts where resource files are read-only, saving still applies the new settings to everyone until the next restart, and the staff member is told the file could not be written.

5. Check OneSync ​

The default General.visibility = 'nearby' shows the spirit to everyone nearby. The server finds those players with server-side coordinates, which need OneSync. OneSync is on by default on current servers.

Without OneSync, set General.visibility = 'local'. Only the player who died then sees the spirit.

6. Restart and test ​

Restart the server, or run ensure leno_spirit_pro in the console. Then type /spiritadmin in game to open the menu, or /spirittest to see the effect without dying.

Next: learn the menu in the User Guide.

Upgrading from LenoSpirit ​

The Pro replaces the free leno_spirit. Both use the same commands, so only one may run.

  1. Remove ensure leno_spirit from server.cfg (and the folder, if you like).
  2. Keep your add_ace ... leno_spirit.admin allow line: the Pro uses the same ACE.
  3. Copy your General settings (activePeriod, visibility, triggerMode...) into the Pro's config.lua. The look (pose, particles, sound) is now set in the menu.
  4. If your death script calls exports.leno_spirit:Trigger(), change it to exports.leno_spirit_pro:Trigger().

While the free version is still running, the Pro prints a warning in the server console.