> For the complete documentation index, see [llms.txt](https://bsensei-script.gitbook.io/bsensei-script-documentation-officiel-fivem/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bsensei-script.gitbook.io/bsensei-script-documentation-officiel-fivem/systemes-and-gestion/bsensei-annonce-entreprise-systeme-dannonce-style/installation.md).

# Installation

## ⚡ Installation du script BSensei Annonces Entreprises

Bienvenue dans le guide d’installation de **BSensei Annonces Entreprises**.

L’installation est rapide et ne nécessite aucune modification de la base de données.

***

### 🧩 Étape 1 – Dépôt du script

Place le dossier du script dans le répertoire `resources` de ton serveur.

Exemple conseillé :

```
resources/[bsensei]/BSensei_annonces
```

⚠️ Conserve le nom du dossier :

```
BSensei_annonces
```

Évite les espaces, les accents et les numéros de version dans le nom de la ressource.

#### ✅ Bon exemple

```
resources/[bsensei]/BSensei_annonces
```

#### ❌ Mauvais exemple

```
resources/[bsensei]/BSensei_annonces_v1.0
```

Vérifie également qu’il n’existe pas de double dossier.

#### ❌ Double dossier

```
resources/[bsensei]/BSensei_annonces/BSensei_annonces
```

***

### 🗄️ Étape 2 – Base de données

**BSensei Annonces Entreprises ne nécessite aucun fichier SQL.**

Aucune table supplémentaire ne doit être créée ou importée.

Le script récupère directement le métier actuel du joueur depuis **ESX Legacy**.

***

### ⚙️ Étape 3 – Ajout dans le `server.cfg`

Ouvre ton fichier `server.cfg`, puis ajoute :

```
ensure BSensei_annonces
```

Le script doit démarrer après ESX.

Ordre conseillé :

```
ensure es_extended

ensure BSensei_annonces
```

💡 Si tu démarres toutes tes ressources BSensei avec le dossier `[bsensei]`, vérifie simplement qu’ESX est chargé avant ce dossier.

***

### 🖼️ Étape 4 – Installation des logos

Les logos des entreprises doivent être placés dans le dossier prévu à cet effet :

```
BSensei_annonces/html/images/
```

Exemple :

```
BSensei_annonces/html/images/police.png
BSensei_annonces/html/images/ambulance.png
BSensei_annonces/html/images/mechanic.png
```

Formats conseillés :

```
.png
.webp
.jpg
```

Pour un meilleur résultat, utilise des images :

* carrées ;
* avec un fond transparent ;
* correctement centrées ;
* de bonne qualité ;
* avec un poids raisonnable.

⚠️ Le nom indiqué dans `config.lua` doit correspondre exactement au nom du fichier.

Exemple :

```lua
logo = "mechanic.png"
```

Le fichier correspondant doit être présent ici :

```
html/images/mechanic.png
```

***

### 🔊 Étape 5 – Vérification du son

Le script peut jouer un son lorsqu’une annonce apparaît.

Les fichiers audio sont placés dans :

```
BSensei_annonces/html/sounds/
```

Vérifie que le fichier configuré existe bien dans ce dossier.

Exemple :

```
BSensei_annonces/html/sounds/notification.mp3
```

Si tu ne souhaites pas utiliser de son, tu pourras le désactiver dans `config.lua`.

***

### 🔧 Étape 6 – Première configuration

Ouvre le fichier :

```
BSensei_annonces/config.lua
```

Vérifie au minimum :

* la commande d’ouverture ;
* la durée d’affichage ;
* le cooldown ;
* la longueur maximale des messages ;
* les métiers autorisés ;
* le label de chaque entreprise ;
* le logo associé à chaque métier.

Exemple :

```lua
Config.Command = "annonce"
```

La commande utilisée en jeu sera alors :

```
/annonce
```

***

### 🧠 Étape 7 – Vérification de l’installation

Redémarre le serveur ou lance les commandes suivantes depuis la console :

```
refresh
ensure BSensei_annonces
```

Connecte-toi ensuite avec un personnage possédant un métier autorisé.

Utilise la commande :

```
/annonce
```

Vérifie que :

1. Le menu s’ouvre correctement
2. Le nom de l’entreprise est correct
3. Le logo apparaît
4. L’éditeur de texte fonctionne
5. Les emojis sont disponibles
6. Les options de mise en forme fonctionnent
7. L’annonce apparaît chez tous les joueurs
8. Le cooldown bloque les annonces trop rapprochées
9. Aucun message d’erreur n’apparaît dans la console F8

***

### 🚫 Test avec un métier non autorisé

Connecte-toi avec un métier absent de la configuration.

Utilise ensuite :

```
/annonce
```

Le script doit refuser l’accès au menu et afficher une notification.

Si le menu s’ouvre malgré tout, vérifie la configuration des métiers dans :

```
BSensei_annonces/config.lua
```

***

### ⚠️ Erreurs à éviter

* Ne renomme pas le dossier après l’avoir ajouté au `server.cfg`
* Ne place pas le script avant `es_extended`
* Ne supprime pas les fichiers présents dans le dossier `html`
* Ne change pas le nom d’un logo sans modifier `config.lua`
* Ne déplace pas les fichiers HTML, CSS ou JavaScript
* Ne supprime pas les virgules dans la configuration Lua
* Ne modifie pas les fichiers protégés du script
* Redémarre la ressource après chaque modification importante

Après une modification :

```
restart BSensei_annonces
```

***

### 🚨 En cas de problème

* Vérifie que `es_extended` est bien démarré
* Vérifie le nom exact du dossier
* Contrôle l’ordre de démarrage dans le `server.cfg`
* Assure-toi que le métier du joueur est autorisé
* Vérifie que le logo configuré existe dans `html/images`
* Contrôle les erreurs dans la console serveur
* Consulte la console F8 du joueur
* Vérifie que les fichiers du dossier `html` sont complets
* Redémarre entièrement le serveur si nécessaire

***

➡️ **Étape suivante : Configuration complète du script**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bsensei-script.gitbook.io/bsensei-script-documentation-officiel-fivem/systemes-and-gestion/bsensei-annonce-entreprise-systeme-dannonce-style/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
