User Guide
Open the menu with /spiritadmin. You need the staff permission (see Installation).
Layout
The menu shows two cards around your character:
- Left card: pick what to change (tabs and lists of poses, effects and sounds).
- Right card: tune it (sliders, switches, inputs).
Hold Q to move the camera while the menu is open.
Preview, test and save
| Control | What it does |
|---|---|
| Live preview | When on, what you change shows on your own character as you go. Only you see it |
| Test on me | Plays the whole effect on you with the current settings, without saving |
| Save | Writes the settings to config.lua and applies them to every player straight away |
| Discard | Drops your unsaved changes and goes back to the saved settings |
| Reset defaults | Puts every setting back to the defaults (asks first) |
Closing the menu with unsaved changes asks first.
Tabs
| Tab | Settings |
|---|---|
| Spirit | Rise height, duration, rotation, starting opacity, when the fade starts, remove hats and glasses |
| Poses | The pose in use (35 tested game poses, plus your own), start height and rotation of each pose. Add pose for an addon animation |
| Particles | On / off. For the start burst, the trail and the end burst: effect, size, opacity, height offset, rotation, trail interval, end delay |
| Sound | On / off and range. Start and end sound, each a game sound or one of your custom sounds |
Spirit
| Setting | Range | Description |
|---|---|---|
| Rise height | 0.5 – 6 m | How far the spirit floats up |
| Duration | 1 – 20 s | Time from appearing to vanishing |
| Rotation | -720° – 720° | Degrees the spirit turns over the whole rise. 0 = no spin, negative = the other way |
| Starting opacity | 51 – 255 | How visible the spirit is at the start |
| Fade start | 0 – 95 % | When the fade-out starts, as a share of the duration |
| Remove hats and glasses | on / off | Takes props off the spirit |
INFO
GTA only renders entity transparency in steps of 51, so the fade happens in a few visible steps. The end particle burst covers the moment the spirit disappears.
Poses
Pick one of the 35 game poses that were tested to look right on a floating spirit. Each pose has its own:
| Setting | Range | Description |
|---|---|---|
| Start height | 0 – 2.5 m | Height above the ground under the body. Lying poses are drawn about 1 m below the ped's origin, so 1.0 starts them inside the corpse |
| Rotation X / Y / Z | -180° – 180° | Tilts the pose, for example to lay a standing animation flat |
Add pose takes an animation dictionary and clip, from an addon resource or the base game. The menu plays it in game first and only lets you save it if it loads. Up to 50 poses can be stored.
Particles
Three one-shot effects: the start burst on the body, the trail that follows the spirit, and the end burst where it vanishes. Each can be turned off on its own.
| Setting | Range | Description |
|---|---|---|
| Effect | — | Any of 2 907 game effects (searchable), or an addon asset + name |
| Size | 0.1 – 5 | 1.0 = normal |
| Opacity | 5 – 100 % | How strong the effect looks |
| Height offset | -3 – 3 m | Positive = higher. Start is measured from the body, trail from the spirit, end from where the spirit vanishes |
| Rotation X / Y / Z | -180° – 180° | Turns the effect |
| Trail interval | 0.1 – 5 s | Trail only: time between two bursts |
| End delay | 0 – 2 s | The spirit stays visible this long after the end burst, so the burst hides its disappearance |
Each pose sits at a different height, so after changing the pose you may want to raise or lower the trail.
Sound
| Setting | Range | Description |
|---|---|---|
| Sounds on / off | — | Turns all spirit sounds on or off |
| Range | 1 – 100 m | How far the sounds are heard |
| Start / end sound | — | Game: search GTA sounds by name and press Listen to hear one. Custom: one of your files from Config.CustomSounds |
| Volume | 0 – 100 % | Custom sounds only. They fade out with the distance, up to the range |
To add your own sound files, see Customization.
On · Off · Automatic
The switch in the menu does the same as /spiritadmin on | off | auto:
| Mode | Effect |
|---|---|
| On | The effect plays for everyone, even with General.enabled = false or outside General.activePeriod |
| Off | The effect is off for everyone, for example during a serious event |
| Automatic | Follows General.enabled and General.activePeriod in config.lua |
The mode is saved, so it stays after a restart.
Two staff members at once
If two staff members edit at the same time, the second save is refused and offers to load the other one's settings first. Nobody overwrites a change they haven't seen.