Documentation

Installer Chiverse sur votre serveurInstall Chiverse on your server

Ce qu'il vous faut

ÉlémentObligatoireRemarque
Un serveur FiveM récent (Lua 5.4)oui
La clé de votre serveurouiElle commence par ock_. Vous l'obtenez sur la page Serveurs.
ESX, QBCore ou QBoxnonSans framework, le jeu s'ouvre avec la commande /chi.
ox_inventory (ou l'inventaire de votre framework)nonPour l'objet « Console Chiverse ».
lb-phone, lb-tabletnonL'application s'y ajoute toute seule.
ox_target ou qb-targetnonPour viser un chi « à l'œil », en plus de la touche E.
ox_libnonPour les notifications ; sinon celles du jeu sont utilisées.

Installation en cinq étapes

Copiez le dossier omega_chi dans vos ressources. Ne le renommez pas : l'objet et les exports portent ce nom.

Ouvrez config_server.lua et renseignez l'adresse du central et votre clé :

ServerConfig = {
    ApiUrl = 'https://api.chiverse.eu',
    ApiKey = 'ock_votre_cle',
}

Ajoutez ensure omega_chi à votre server.cfg, après votre framework, votre inventaire et votre téléphone.

Redémarrez le serveur. La console doit afficher [omega_chi] relié au serveur central.

Essayez en jeu avec /chi. Tant que Config.TestMode = true (dans config.lua), seuls les administrateurs y ont accès ; passez-le à false pour ouvrir le jeu à tous.

config_server.lua n'est lu que par le serveur : la clé n'est jamais envoyée aux joueurs. Ne la publiez pas, et retirez-la avant de transmettre le dossier à quelqu'un d'autre.

L'objet « Console Chiverse »

Le joueur utilise l'objet depuis son inventaire et la console s'ouvre, comme avec /chi. Avec ox_inventory, collez ce bloc dans ox_inventory/data/items.lua :

['chi_console'] = {
    label = 'Console Chiverse',
    description = 'Une console portable pour capturer, élever et faire combattre vos chi.',
    weight = 300,
    stack = false,
    close = true,
    client = {
        image = 'chi_console.png',
        export = 'omega_chi.useConsole',
    },
},

Copiez ensuite install/chi_console.png dans ox_inventory/web/images/, puis redémarrez ox_inventory. Pour ESX sans ox_inventory et pour QBCore, les lignes à ajouter sont dans le fichier README.md de la ressource.

Config.RequireItem = true : la commande et la touche demandent alors de posséder l'objet. L'application du téléphone reste accessible sans lui.

Comment les joueurs y accèdent

AccèsDétail
Commande/chi ouvre la console. Une touche peut être associée dans les réglages du jeu.
Objet« Console Chiverse », voir plus haut.
lb-phone, lb-tabletApplication ajoutée automatiquement.
Dans le mondeTouche E près d'un chi ou d'un lieu, ou visée « à l'œil ».

Discret par défaut. Un joueur qui n'a jamais ouvert Chiverse ne voit rien : ni repères, ni chi, ni attaques. Le jeu s'active pour lui à sa première ouverture. Ensuite, /chiveille ou le bouton lune masque tout et le réaffiche, et Plus > Affichage en jeu règle chaque élément un par un. Pour tout afficher dès la connexion, mettez Config.StartAsleep = false.

Les lunettes

En activant le jeu, le joueur met ses lunettes : un geste, des lunettes sur le visage et un filtre léger à l'écran. C'est à travers elles qu'il voit les chi et les compagnons des autres dresseurs. En veille, il les retire.

Dans Config.Glasses : male et female donnent le modèle de lunettes des personnages « freemode ». Choisissez-les dans votre menu de vêtements ; drawable = -1 garde les lunettes du personnage. filter = '' retire le filtre de l'écran, enabled = false retire les lunettes pour tout le monde.

Ce que vous réglez

Vous vous connectez à votre espace serveur avec la clé de votre serveur.

Vous pouvezDétail
Masquer du contenu officielDécochez une zone ou un lieu : il disparaît chez vous seulement.
Créer vos zonesEmplacement, rayon, nombre de chi. Choisissez un modèle : la zone officielle dont la vôtre reprend les chi et les niveaux.
Poser des sources, des refuges et des ranchs20 lieux au plus.
Choisir le mode des zonesAutomatique : zones officielles plus les vôtres. Personnalisées : uniquement les vôtres.
Vous retirer d'un événementPage Événements.

En jeu, /chipos (administrateurs) affiche vos coordonnées pour créer une zone ou un lieu. Pour que le jeu reste équitable entre les serveurs, vous ne choisissez pas les chi ni les niveaux d'une zone, et vous ne créez ni donjon ni arène.

Boutique

Les packs se vendent sur votre boutique Tebex. Votre stock de packs est prépayé : chaque livraison le décompte, et une livraison sans stock est refusée. Commande à mettre dans le paquet Tebex (exécution « quand le joueur est en ligne ») :

chi_grant {sid} sceaux_parfaits_5 {transaction}

Les objets achetés sont liés au compte du joueur : ils ne s'échangent pas. Votre boutique doit respecter les règles de la plateforme FiveM : pas de monnaie virtuelle vendue contre de l'argent réel, pas de contenu aléatoire payant.

En cas de souci

Ce que vous voyezCe qu'il faut regarder
aucune clé dans config_server.luaApiKey est vide.
le serveur central ne répond pas (401)La clé est fausse ou a été remplacée.
le serveur central ne répond pas (0)L'adresse ApiUrl est fausse, ou le central est injoignable depuis votre machine.
/chi répond « pas disponible »Config.TestMode est à true et vous n'êtes pas administrateur.
Un joueur ne voit ni repères ni chiIl n'a jamais ouvert le jeu, ou il est en veille (/chiveille).
Les chi apparaissent la tête en basConfig.WorldSprites.flipV = true.
Baisse de performance près des zonesBaissez Config.WorldSprites.max, ou passez enabled à false.
Les lunettes ne vont pas avec vos tenuesChangez Config.Glasses.male / female, ou mettez drawable = -1.
L'objet n'ouvre rienVérifiez le nom chi_console et la ligne export = 'omega_chi.useConsole'.

Mises à jour

Les nouveaux chi, lieux, quêtes, événements et réglages arrivent par le central : vous n'avez rien à faire. Seule une nouvelle version de la ressource demande de remplacer le dossier ; gardez alors votre config.lua et votre config_server.lua. Les nouvelles versions sont annoncées sur la page Nouveautés.

Requirements

ItemRequiredNote
A recent FiveM server (Lua 5.4)yes
Your server keyyesIt starts with ock_. Get it on the Servers page.
ESX, QBCore or QBoxnoWithout a framework, the game opens with the /chi command.
ox_inventory (or your framework's inventory)noFor the "Chiverse Console" item.
lb-phone, lb-tabletnoThe app is added automatically.
ox_target or qb-targetnoTo target a chi, on top of the E key.
ox_libnoFor notifications; otherwise the game's own are used.

Installation in five steps

Copy the omega_chi folder into your resources. Do not rename it: the item and exports use that name.

Open config_server.lua and fill in the central address and your key:

ServerConfig = {
    ApiUrl = 'https://api.chiverse.eu',
    ApiKey = 'ock_your_key',
}

Add ensure omega_chi to your server.cfg, after your framework, inventory and phone.

Restart the server. The console should show that the resource is linked to the central server.

Try it in game with /chi. While Config.TestMode = true (in config.lua), only admins can use it; set it to false to open the game to everyone. Set Config.Locale = 'en' for English in-game texts.

config_server.lua is only read by the server: the key is never sent to players. Do not publish it, and remove it before passing the folder on to anyone else.

The "Chiverse Console" item

Players use the item from their inventory and the console opens, just like /chi. With ox_inventory, paste this block into ox_inventory/data/items.lua:

['chi_console'] = {
    label = 'Chiverse Console',
    description = 'A handheld console to catch, raise and battle your chi.',
    weight = 300,
    stack = false,
    close = true,
    client = {
        image = 'chi_console.png',
        export = 'omega_chi.useConsole',
    },
},

Then copy install/chi_console.png into ox_inventory/web/images/ and restart ox_inventory. For ESX without ox_inventory and for QBCore, the lines to add are in the resource's README.md.

Config.RequireItem = true: the command and key then require owning the item. The phone app stays available without it.

How players get in

AccessDetail
Command/chi opens the console. A key can be bound in the game settings.
Item"Chiverse Console", see above.
lb-phone, lb-tabletApp added automatically.
In the worldE key near a chi or a place, or targeting.

Quiet by default. A player who never opened Chiverse sees nothing: no markers, no chi, no ambushes. The game wakes up for them the first time they open it. After that, /chiveille or the moon button hides and shows everything, and More > In-game display sets each element one by one. To show everything on login, set Config.StartAsleep = false.

The glasses

When the game wakes up, the player puts on their glasses: a gesture, glasses on the face and a light screen filter. Through them they see chi and other trainers' companions. They come off in sleep mode.

In Config.Glasses: male and female set the glasses model for freemode characters. Pick them from your clothing menu; drawable = -1 keeps the character's own glasses. filter = '' removes the screen filter, enabled = false removes the glasses for everyone.

What you control

Log in to your server area with your server key.

You canDetail
Hide official contentUntick a zone or place: it disappears on your server only.
Create your zonesLocation, radius, number of chi. Pick a model: the official zone whose chi and levels yours will copy.
Place springs, sanctuaries and ranches20 places at most.
Choose the zone modeAutomatic: official zones plus yours. Custom: yours only.
Opt out of an eventEvents page.

In game, /chipos (admins) shows your coordinates for creating a zone or place. To keep the game fair across servers, you do not choose a zone's chi or levels, and you cannot create dungeons or arenas.

Store

Packs are sold on your Tebex store. Your pack stock is prepaid: each delivery uses it up, and a delivery without stock is refused. Command to put in the Tebex package (run "when the player is online"):

chi_grant {sid} sceaux_parfaits_5 {transaction}

Purchased items are bound to the player's account: they cannot be traded. Your store must follow the FiveM platform rules: no virtual currency sold for real money, no paid random content.

Troubleshooting

What you seeWhat to check
No key in config_server.luaApiKey is empty.
Central server not responding (401)The key is wrong or was replaced.
Central server not responding (0)ApiUrl is wrong, or the central cannot be reached from your machine.
/chi says "not available"Config.TestMode is true and you are not an admin.
A player sees no markers and no chiThey never opened the game, or they are in sleep mode (/chiveille).
Chi appear upside downConfig.WorldSprites.flipV = true.
Performance drops near zonesLower Config.WorldSprites.max, or set enabled to false.
The glasses clash with your outfitsChange Config.Glasses.male / female, or set drawable = -1.
The item does nothingCheck the name chi_console and the line export = 'omega_chi.useConsole'.

Updates

New chi, places, quests, events and settings come from the central: nothing to do on your side. Only a new version of the resource requires replacing the folder; keep your config.lua and config_server.lua. New versions are announced on the News page.