Installation & Configuration

Requirements

A FiveM server. No framework, FS-Lib, database, or UI library is required by the cleaner.
A compatible chat resource to display command suggestions.
Optional target and notification providers, with their own dependencies, if you want those integrations.

Use the built FS-EntityCleaner resource folder. If working from source, install the project's package dependencies and run npm run build from the project root. This creates the FS-EntityCleaner/ output folder.

Source files, including fxmanifest.lua and config.lua, live in src/. The build places the manifest and config at the output resource root and client/server scripts under dist/.

Copy the built FS-EntityCleaner folder into your server's resources directory. Add this to server.cfg:

ensure FS-EntityCleaner

Start optional integration resources before the cleaner when using them. Install their dependencies according to their own documentation.

Edit config.lua in the deployed resource. When maintaining the source project, edit src/config.lua and rebuild before deploying; otherwise a later build will overwrite changes made only to the output config.

Restart the FS-EntityCleaner resource after configuration changes. Run /entitydelete to check selection and controls before using the immediate deletion commands.

Cleanup and targeting settings

Distances are in metres and measured from the player's ped to the entity origin.

Prop

Type

Use positive distances and scan intervals, and non-negative timeouts. The resource only scans entity pools continuously while confirmation targeting is active.

ACE permissions

Prop

Type

Enable permissions in the config:

Config.Ace = {
    enabled = true,
    permission = 'fs.entitycleaner',
}

Grant the permission in server.cfg, replacing the example license with the administrator's identifier:

add_ace group.admin fs.entitycleaner allow
add_principal identifier.license:YOUR_LICENSE_HERE group.admin

Denied users receive an error notification. Target options are filtered by entity eligibility; permission is checked when an option is selected. ACE controls access through this resource and is not an anti-cheat for modified clients.

Optional integrations

Config.Target.system and Config.Notifications.system both default to 'auto'. See Target & Notification Integrations for provider selection, defaults, fallback behavior, and custom adapters.

Troubleshooting

Issue	What to check
No entity selected	Move within the configured range. Player peds and protected occupied vehicles are excluded; the entity must be streamed to your client.
Could not obtain network control	Server control policies or ownership may block the request. Try again or review those policies.
Deletion failed or entity returns	Another resource may protect or recreate the entity. Review the resource that manages it.
No chat suggestions	Confirm your chat supports the standard `chat:addSuggestion` event. Restart chat/the cleaner and type a command prefix.
No target-menu options	Check the selected provider is running, the entity is eligible, and you are within `Config.Target.distance`.
Native notifications appear instead of a library	The selected provider is unavailable or its export failed. Check client console errors and provider start order.