Tool for spawning, placing, and removing entities, inspired by Menyoo's Object Spooner.
- Freecam mode with a variety of options for placing and adjusting entities
- Searchable, optimized lists of peds, vehicles and objects with in-game preview before spawning
- View and set properties of an entity, including attaching entities to one another (with bone search)
- Create and customize MP peds with outfit randomization, and save them for reuse (RedM)
- Save and load sets of entities
- Saved databases are stored client-side, so you can load them on any server with this resource
- Import and export sets of entities to share with others or to convert to a permanent map
- Permissions system for controlling access to individual features
- Copy entity details such as Id, NetId, Model, Coords, Rotation
- Copy camera coords/rotation, attachment settings and animations as ready-to-use native code (e.g.
AttachEntity,TaskPlayAnim) - Preview object animations with a timeline calculator and entity offset calculator
- Display of the current interior (name, room) and player routing bucket
- Physics push (entity slap) for nudging entities
None. Works on both FiveM and RedM with no external dependencies.
-
Place the resource in your
resourcesdirectory. -
Add the following to
server.cfg:exec @luman-spooner/permissions.cfg ensure luman-spooner -
Restart the server.
Key options in config.lua:
| Option | Default | Description |
|---|---|---|
Config.MaxEntities |
10 |
Max entities a player without spooner.noEntityLimit can spawn at a time |
Config.CleanUpOnStop |
true |
Remove all spawned entities when the resource is stopped |
Config.Speed |
0.10 |
Default freecam movement speed |
Config.AdjustSpeed |
0.01 |
Speed of X/Y/Z entity adjustments |
Config.RotateSpeed |
1.0 |
Speed of pitch/roll/yaw adjustments |
Config.EntityHandleDrawDistance |
20.0 |
Draw distance for entity handles |
All keybinds are also defined in config.lua (Config.*Control).
| Command | Where | Description |
|---|---|---|
spooner |
Client | Toggle Object Spooner on/off (same as F5) |
spooner_db |
Client | Open the Database menu |
spooner_savedb |
Client | Open the Save/Load Database menu |
spooner_migrate_old_dbs |
Client | Migrate saved databases from the old storage format |
spooner_refresh_perms |
Server | Refresh spooner permissions on all clients |
By default all players have full access. To limit which players can use the spooner or what parts they can access, edit permissions.cfg.
Example:
add_ace builtin.everyone spooner.view allow
add_ace builtin.everyone spooner.spawn allow
add_ace builtin.everyone spooner.modify.own allow
add_ace builtin.everyone spooner.delete.own allow
add_ace builtin.everyone spooner.properties allow
add_ace group.admin spooner.noEntityLimit allow
add_ace group.admin spooner.modify.other allow
add_ace group.admin spooner.delete.other allow
This lets all players spawn a limited number of entities and modify/delete only their own, while admins can spawn any number of entities and modify/delete other players' entities.
Permissions are granular — you can restrict individual spawn types (spooner.spawn.ped, spooner.spawn.vehicle, ...) and individual properties (spooner.properties.ped.weapon, spooner.properties.vehicle.repair, ...). The full list is documented in the comments of permissions.cfg.
After changing any spooner aces while the server is running, run spooner_refresh_perms to apply them on all clients, or restart the resource.
| Colour | Meaning |
|---|---|
| white | No entity selected |
| green | Entity highlighted |
| blue | Entity attached |
| Control | Function |
|---|---|
| W/A/S/D | Move |
| Spacebar/Shift | Up/Down |
| E | Spawn |
| Left click | Entity highlighted: Attach, Entity attached: Detach |
| Right click | Delete selected entity |
| C/V | Rotate |
| B | Change rotation axis |
| Q/Z/Arrow keys | Adjust selected entity position |
| I | Cycle between controlled mouse adjustment modes |
| U | Toggle whether entities stick to the ground in controlled mouse adjustment modes |
| 7 | Turn off mouse adjustment |
| 8 | Return to Free mouse adjustment mode |
| G | Clone selected entity |
| Pg Up/Pg Down/Mouse wheel | Change currently selected speed |
| R | Cycle between which speed to change |
| M | Toggle entity handles |
| Left Alt | Focus on the selected entity |
| Left Ctrl | Toggle focus mode |
| 2 | Copy camera coords and rotation to clipboard |
| 1 | Show/hide the controls overlay |
| F | Open the Spawn menu |
| X | Open the Database menu |
| Tab | Open the Properties menu for the selected entity |
| J | Open the Save/Load Database menu |
| H | Open the Help menu |
| F5 | Toggle Object Spooner on/off |
| Escape/Delete | Exit Object Spooner |
All keys can be rebound in config.lua.
While a menu is open, hold the right mouse button to hide the cursor and look around; release it to return to the menu.
The Spawn menu provides searchable lists to select an entity to spawn. Left-clicking on an entity sets it as your current spawn.
If an entity is not in the list, enter its full model name in the search field and click Spawn By Name.
Right-click an entity in any spawn menu to add it as a favourite. Click the favourites button to toggle showing only favourited entities.
The Database menu stores a list of entities. When an entity is spawned, it is automatically added to the current database. Existing entities can be added/removed from the database via the Properties menu.
- Left-click an entity to open it in the Properties menu
- Right-click an entity to delete it
- Click Delete All to delete all entities in the database
The Properties menu lists and lets you edit the properties of an entity.
The Save/Load Database menu lets you store your current database with a name and load its entities again later.
-
To save, enter a name in the field and click Save.
-
To load, left-click the name of the database.
-
To delete, right-click the name of the database.
-
To import or export, click Import/Export.
-
Load relative to cursor position — spawns entities relative to the current cursor position instead of their original coordinates.
-
Replace current DB — replaces your current database with the loaded one instead of merging them.
-
Save/Load deletions — saves which entities you delete and deletes them again when the database is loaded.
The Import/Export menu imports and exports databases in several formats:
| Format | Description | Export? | Import? |
|---|---|---|---|
| Spooner DB JSON | The native format used by the spooner | Yes | Yes |
| Map Editor XML | XML format used by the Lambdarevolution map editor and the objectloader resource | Yes | No |
| Ymap | Native map format used by GTA V/RDR2 | Yes | Yes |
| propplacer JSON | RedEM:RP propplacer JSON database | Yes | No |
| Spooner Backup | Backup of all spooner databases | Yes | Yes |
To export, select the format and click Export. Copy the output from the text box to save it.
To import, paste the input into the text box, select the format, and click Import. Imported objects are added to your current database.
Enter a URL of a JSON/XML file in the Import from URL field and click Import to import from an external source (e.g. pastebin.com). Make sure the URL points to the raw version of the file.
Original repository https://github.com/kibook/spooner