Gameplay

ShadowBoost

Reward your Discord Nitro boosters automatically, in game.

Version
2.2.1
Resource
SF-Boost
Version 2.2.1 Resource SF-Boost Frameworks ESX Legacy ยท ESX Extended ยท QBCore Bundled languages 5 Store page View

Overview#

SF-Boost connects to your Discord server through a bot, checks whether the player holds the booster role, and hands out the rewards you configured. Money, items, experience or fully custom rewards, with a cooldown so the same player cannot claim twice. Inventory support is detected automatically across the main frameworks.

Automatic booster check

The bot reads the roles of the player on your Discord and confirms the boost.

Configurable rewards

Money, items, experience or a custom reward, alone or combined.

Claim cooldown

Twenty-four hours by default, so a booster claims once per day.

Modern interface

A clean panel showing the boost status and what is available to claim.

Inventory detection

Detects ox_inventory, qs-inventory and qb-inventory without any configuration.

Discord logging

Every claim is posted to a webhook with the player and the reward.

Dependencies#

ResourceRequiredWhy
OneSyncYesDeclared as a hard dependency in the manifest.
Discord botYesA bot token is needed to read the roles of your members.

Installation#

  1. Drop the SF-Boost folder into your server resources directory.
  2. Create a Discord application, add a bot to it and copy its token.
  3. Invite the bot to your Discord server. It needs permission to read members and their roles.
  4. Fill in the bot token, your guild ID and the booster role ID in config.lua.
  5. Define your rewards, then add the ensure line to your server.cfg and restart.
server.cfg
ensure SF-Boost

Configuration#

KeyDefaultWhat it does
Config.discordTokenโ€”Token of the bot that reads the roles. Keep it server-side only.
Config.guildIdโ€”ID of your Discord server.
Config.boosterRoleIdโ€”ID of the role given to Nitro boosters.
Config.cooldown86400Delay in seconds between two claims, 24 hours by default.
Config.rewardsโ€”The list of rewards: money, items, experience or custom.
Config.inventorySystem'auto'Force an inventory, or leave auto-detection on.
Config.discordInviteโ€”Invitation link shown to players who are not on the Discord yet.
Config.languageโ€”Language of the interface and the messages.
Config.enableLogsโ€”Enables Discord logging of claims.
Config.logWebhookโ€”Webhook URL that receives the claim logs.

Commands#

CommandPermissionWhat it does
/boostโ€”Open the boost panel and see the available rewards.
/claimboostโ€”Claim the reward directly, without opening the panel.
/discordโ€”Show the invitation link to your Discord server.
/resetcooldown [id]AdminReset the cooldown of a player.

Good to know#

The bot token is only ever used server-side: it is never sent to the client.
The bot must be a member of the guild and have permission to read the member list, otherwise the role check always returns false.