Plugins

Récompensez en jeu les joueurs qui votent pour votre serveur sur Serveur Privé. Le plugin utilise ESX, QBCore ou Qbox et nécessite oxmysql ainsi qu’un serveur FiveM build 9515 ou supérieur.

Télécharger la version 2.0

Installation

1. Téléchargez le ZIP ci-dessus et décompressez le dossier sp-vote dans le dossier resources de votre serveur FiveM.
2. Installez oxmysql et configurez sa connexion à la base de données de votre serveur.
3. Dans sp-vote/config.lua, choisissez Config.Framework = 'auto', 'esx', 'qbcore' ou 'qbox'.
4. Renseignez Config.Token avec le token API de votre fiche Serveur Privé, disponible dans votre espace de gestion. Gardez-le privé.
5. Réglez Config.Locale sur 'fr' ou 'en' et Config.Reward.Money sur le montant par vote : 500 par défaut.
6. Dans server.cfg, démarrez ensure oxmysql, puis votre framework (ensure es_extended, ensure qb-core ou ensure qbx_core), puis ensure sp-vote.
7. Au démarrage, le plugin crée ou met à jour automatiquement la table sp_vote_rewards. Le compte SQL doit pouvoir créer et modifier cette table. Aucun fichier SQL à importer.

Le même ZIP inclut les messages joueurs en français et en anglais. Config.Locale choisit leur langue ; le code source et les messages console sont en anglais.

Recevoir une récompense

Votez sur la fiche de votre serveur avec votre pseudo FiveM exact, pas le nom de votre personnage RP. Le plugin récupère les votes toutes les 30 secondes et remet automatiquement les récompenses en jeu, sans commande à saisir. Les récompenses en attente sont conservées pour votre prochaine connexion.

Un pseudo est modifiable et ne constitue pas une preuve d’identité.

L’historique est nettoyé automatiquement chaque heure. Un vote payé ou annulé est supprimé uniquement lorsque le vote et son paiement ou son annulation datent tous les deux de plus de 7 jours. Les votes en attente et ceux à vérifier sont toujours conservés.

Configurer la récompense

Pour attribuer 500 unités d’argent par vote, réglez cette valeur dans sp-vote/config.lua :

Config.Reward.Money = 500

Exemples ESX, QBCore et Qbox

Ces exemples versent 750 sur le compte bancaire du joueur. Choisissez un seul exemple, correspondant à votre framework, et placez-le dans sp-vote/config.lua. Config.Reward.Handler remplace la récompense Config.Reward.Money. Aucune modification côté client n’est nécessaire.

Config.Reward.Handler = function(source, player, vote)
    if not player.getAccount('bank') then
        return false
    end
    return player.addAccountMoney('bank', 750, 'serveur-prive-vote') ~= false
end

Config.Reward.Handler = function(source, player, vote)
    return player.Functions.AddMoney('bank', 750, 'serveur-prive-vote') == true
end

Config.Reward.Handler = function(source, player, vote)
    return exports.qbx_core:AddMoney(source, 'bank', 750, 'serveur-prive-vote') == true
end

La fonction reçoit source (identifiant du joueur connecté), player (objet du framework) et vote (voted_at, username, player_identifier : identifiant persistant préfixé du personnage). Retournez true uniquement après attribution ; false signifie qu’aucune récompense n’a été donnée et autorise un réessai au prochain passage, environ toutes les 30 secondes. Une erreur ou un retour manquant bloque le vote pour vérification manuelle. Après contrôle du paiement, utilisez dans la console du serveur sp_vote_resolve <voted_at> rewarded <username...> s’il a été effectué, ou sp_vote_resolve <voted_at> retry <username...> sinon.

Événements avant et après la récompense

sp-vote:preVoteReward(playerSource, vote) se déclenche avant la récompense. Appelez CancelEvent() pour l’annuler définitivement, sans réessai.

sp-vote:postVoteReward(playerSource, vote) se déclenche après une récompense réussie, pour vos logs ou notifications.

Exemple côté serveur : annuler la récompense hors de l’instance 0 et journaliser les récompenses accordées.

AddEventHandler('sp-vote:preVoteReward', function(playerSource, vote)
    if GetPlayerRoutingBucket(playerSource) ~= 0 then
        CancelEvent()
    end
end)

AddEventHandler('sp-vote:postVoteReward', function(playerSource, vote)
    print(('[sp-vote] Reward confirmed for %s (source %s, player %s, vote %s)'):format(
        vote.username, tostring(playerSource), vote.player_identifier, vote.voted_at
    ))
end)

vote contient username, voted_at et player_identifier. playerSource est l’ID du joueur : dans le post, il peut être nil après une déconnexion ou un changement de personnage. Vérifiez-le avant de l’utiliser ; vote.player_identifier reste disponible.

Le plugin interroge notre API depuis votre serveur. Aucun port UDP supplémentaire à ouvrir.

Versions disponibles

Un même bot, deux usages : suivez vos serveurs de jeu favoris sur votre compte Discord, ou reliez le Discord de votre communauté à votre fiche Serveur Privé pour encourager les votes et suivre son activité.

Pour les joueurs

Ajoutez vos serveurs préférés et activez les rappels pour ne jamais manquer un vote.

• Gardez jusqu’à 25 serveurs favoris à portée de main et accédez facilement à leurs liens de vote.
• Activez les rappels pour les favoris de votre choix : après chaque vote, recevez un MP quand vous pouvez revoter.
• Consultez les classements, statistiques et avis de vos favoris directement dans Discord.

Ajouter à mon compte Discord

1. Dans /profil, cherchez un serveur par son nom ou collez le lien de sa fiche SP, puis ajoutez-le aux favoris.
2. Activez les rappels d’un favori. Après chaque vote, le bot vous prévient quand vous pouvez revoter. Arrêtez les rappels à tout moment.
3. Gardez le pseudo Discord prérempli pour que le bot reconnaisse vos votes.
4. Choisissez aussi votre langue dans /profil.

Certains serveurs demandent de voter via leur site ou leur Discord. Le bot vous guide et indique si les rappels sont disponibles. La fiche et les statistiques restent accessibles.

---

Pour les serveurs

Encouragez votre communauté à voter pour votre serveur de jeu et mettez vos votants à l’honneur dans votre Discord.

• Facilitez le vote avec un panneau dédié et remerciez automatiquement les votants dans un salon.
• Affichez un classement actualisé des votants et publiez les nouveaux avis dans les salons de votre choix.
• Proposez des rappels en MP ou dans un salon, activés par chaque membre, et consultez les statistiques détaillées de votre serveur.

Ajouter à mon serveur Discord

1. Pour installer le bot, vous devez disposer de la permission « Gérer le serveur ». Dans /config, saisissez le token API de votre fiche SP, disponible dans votre espace de gestion. Gardez-le privé.
2. Publiez un panneau de vote et choisissez les salons des remerciements automatiques, du classement des votants et des nouveaux avis.
3. Réglez les rappels : en MP, dans un salon ou désactivés. Chaque membre active les siens.
4. La langue suit votre fiche SP. Choisissez le français ou l’anglais dans /config si besoin.

Configurer une URL de vote personnalisée

Dans les réglages de votre fiche SP, choisissez « URL personnalisée » pour ouvrir votre plateforme depuis le bouton de vote. Ajoutez obligatoirement {discord_username} pour transmettre le pseudo Discord du joueur.

https://exemple.fr/voter?username={discord_username}

Conservez ce pseudo et transmettez-le à Serveur Privé lors du vote pour que le bot puisse envoyer les rappels.

Avec l’OTP, votre plateforme doit générer son propre jeton et le transmettre au vote SP pour validation. Le bot n’ajoute aucun jeton à votre URL.