Installer tlr_core

Cette page vous mène, étape par étape, d'un serveur vide à un serveur ouvert avec tlr_core, la console web et votre compte de fondateur. Comptez une demi heure.

Pages liées : Configuration · Mise à jour · Dépannage et FAQ · Commandes · Console web · API

1. Prérequis

tlr_core est chiffré par l'escrow Cfx : il ne démarre que sur un serveur dont la clé sv_licenseKey appartient au même compte Cfx.re que celui qui a acheté la ressource.

2. Télécharger et copier la ressource

1. Sur https://portal.cfx.re, menu Assets, téléchargez la dernière version de tlr_core.
2. Décompressez l'archive dans le dossier resources de votre serveur, par exemple resources/[tlr]/tlr_core.
3. Le dossier doit s'appeler exactement tlr_core : les adresses de la console web et les autres ressources s'en servent.
4. Copiez aussi oxmysql dans resources si ce n'est pas déjà fait.
5. Retirez toute autre ressource d'écran de chargement (une seule ressource peut déclarer loadscreen) et le cœur d'un autre framework (RSG Core, VORP) s'il était installé : tlr_core le remplace.

3. Préparer la base de données

Créez une base vide (HeidiSQL, phpMyAdmin, ou le panel de votre hébergeur), par exemple tlr, en utf8mb4. Notez l'hôte, le port, l'utilisateur, le mot de passe et le nom de la base.

Vous n'avez rien à importer : au premier démarrage, tlr_core crée toutes ses tables tout seul (migrations automatiques, voir Mise à jour). Le dossier install/ contient des fichiers SQL seulement pour les hébergeurs qui interdisent la création de tables par la ressource (voir install/LISEZMOI.md).

4. Régler server.cfg

Le modèle complet et commenté est fourni : install/server.cfg. Copiez le à la racine de votre serveur (à côté du dossier resources) ou reprenez ses lignes dans votre propre fichier si vous utilisez txAdmin.

Les lignes indispensables :

sv_licenseKey "VOTRE_CLE_CFX"
set gamename rdr3
set onesync on

set mysql_connection_string "mysql://UTILISATEUR:MOTDEPASSE@HOTE:3306/BASE?charset=utf8mb4"

set tlr_licence_key "VOTRE_CLE_TLR"
set tlr_founder "license:VOTRE_LICENCE_ROCKSTAR"
set tlr_console_url "http://IP_PUBLIQUE:30120"

ensure oxmysql
ensure tlr_core

add_ace identifier.license:VOTRE_LICENCE_ROCKSTAR tlr.founder allow

Les deux clés

• Clé Cfx.re (sv_licenseKey) : sans elle, FXServer ne démarre pas. Elle doit venir du compte Cfx.re qui a acheté tlr_core.
• Clé TLR (tlr_licence_key) : elle active tlr_core. Elle est liée à l'adresse IP de votre serveur : si l'IP change, tapez /changerip sur le Discord du vendeur.

Ne partagez jamais votre server.cfg : il contient ces deux clés et le mot de passe de la base.

Votre licence Rockstar (fondateur)

Le fondateur a tous les droits, au dessus de tous les groupes. Pour trouver votre licence Rockstar : démarrez le serveur une première fois, connectez vous, et lisez la ligne affichée dans la fenêtre du serveur (license: suivi de 40 caractères). Mettez la dans les deux lignes :

• add_ace identifier.license:... tlr.founder allow : le droit fondateur en jeu ;
• set tlr_founder "license:..." : la même licence, lue par la console web même quand vous n'êtes pas connecté en jeu. Plusieurs fondateurs : licences séparées par des virgules.

Ordre des ensure

ensure mapmanager
ensure sessionmanager
ensure hardcap
ensure oxmysql      # toujours avant tlr_core
ensure tlr_core     # le cœur
# ensure mon_module # vos modules qui utilisent tlr_core, toujours après

N'activez pas spawnmanager : tlr_core gère lui même l'écran des personnages et l'apparition. Si spawnmanager tourne, le joueur peut apparaître avant l'écran des personnages.

Convars de tlr_core

5. Premier démarrage

Démarrez le serveur et regardez la fenêtre FXServer :

1. Licence : un bloc [tlr_core:licence] affiche la formule, la date d'expiration et Licence : OK. Si la licence est refusée, la raison s'affiche en rouge : voir Dépannage.
2. Base de données : les migrations s'appliquent (la première fois, quelques secondes à une minute).
3. Services : chaque étape passe au vert (base, paramètres, permissions, métiers, objets, armes, monde, portes, zones, blips, cibles), puis le cœur s'annonce prêt.
4. Console web : tant qu'aucun compte web n'existe, un code d'installation s'affiche en jaune avec l'adresse de la console. Il est aussi écrit dans tlr_core/console_setup.txt.

La commande console tlr_diag affiche à tout moment l'état du cœur, de chaque service et de la configuration. Si une étape indispensable échoue, le cœur reste « non prêt » et refuse les joueurs avec un message clair ; corrigez la cause puis restart tlr_core.

6. Créer le compte fondateur de la console web

La console web remplace txAdmin pour l'administration courante. Elle est servie par la ressource, sur le port du serveur :

http://IP_DU_SERVEUR:30120/tlr_core/console/

1. Ouvrez cette adresse : l'écran Installation s'affiche tant qu'aucun compte n'existe.
2. Entrez le code d'installation (fenêtre du serveur, ou fichier tlr_core/console_setup.txt en SFTP).
3. Entrez votre licence Rockstar (celle de tlr_founder / tlr.founder ; une autre est refusée), un identifiant et un mot de passe de 10 caractères au moins.
4. Validez : vous êtes connecté avec tous les droits. Le code et le fichier sont détruits.

Autres façons d'obtenir un code : en jeu, connecté avec votre licence de fondateur, /consolecode (onglet Premier accès de la console) ; dans la fenêtre du serveur, tlr_console_setup (nouveau code d'installation) ou tlr_console_invite <licence ou id>.

Pour exposer la console sur Internet, mettez un HTTPS devant (tunnel Cloudflare, nginx ou Caddy) et réglez tlr_console_https, tlr_console_trust_proxy et tlr_console_secret. Détails : Console web.

7. Donner des droits à l'équipe

• En jeu : /tlr, section Permissions, choisir un groupe pour un joueur connecté.
• Dans la fenêtre du serveur : tlr_setgroup <id joueur ou license:...> <groupe ou aucun>.
• Accès à la console web : écran Accès web (invitation valable 15 minutes, à usage unique).

Les groupes admin (niveau 80) et moderator (niveau 40) sont créés au premier démarrage depuis config/config.lua. Tout ce qui n'est pas accordé est refusé ; on ne gère que les groupes de niveau inférieur au sien.

8. Redémarrer sans txAdmin

Un redémarrage programmé (console web, ou tlr_restart_times) déconnecte les joueurs puis arrête FXServer. Il faut que quelque chose le relance :

• chez un hébergeur de jeux : activez le redémarrage automatique en cas d'arrêt ;
• sur Windows, un fichier lancer.bat qui boucle :

:boucle
FXServer.exe +exec server.cfg
timeout /t 5
goto boucle

• sur Linux : un service systemd avec Restart=always.

9. Bots Discord (facultatif)

tlr_core fonctionne sans aucun bot. Le bot staff (tlr_staffbot, livré à part si votre offre le comprend) permet au staff de réanimer, soigner et téléporter un joueur depuis Discord :

1. Choisissez une clé aléatoire de 16 caractères ou plus et mettez la dans server.cfg : set tlr_staffbot_key "...".
2. Mettez la même clé et l'adresse du serveur (http://IP:30120/tlr_core) dans la configuration du bot (voir son propre LISEZMOI).
3. Facultatif : set tlr_console_founder_discord "VOTRE_ID_DISCORD" pour recevoir le code d'installation de la console en message privé.

Sans tlr_staffbot_key, le point d'entrée du bot refuse toute requête.

10. Écran de chargement et carte

• L'écran de chargement est dans web/loading/ : nom et message par convars, le reste (astuces, thème) dans web/loading/config.js. Voir chargement et images.
• La carte en direct de la console utilise les tuiles du jeu dans web/console/map/tiles/ (© Rockstar Games, créditées dans web/console/map/ATTRIBUTION.md). Supprimer ce dossier ramène la carte papier fournie.

Et ensuite

• Réglez votre serveur : Configuration, puis le panel en jeu (/tlr).
• Prise en main du panel : guide.
• Un problème : Dépannage et FAQ.

Source : tlr_core/docs/INSTALLATION.md