Skip to content

Commit b79ba21

Browse files
committed
Add Wiki
1 parent 4b3abdb commit b79ba21

File tree

2 files changed

+254
-253
lines changed

2 files changed

+254
-253
lines changed

README.md

+1-253
Original file line numberDiff line numberDiff line change
@@ -47,256 +47,4 @@ Si vous souhaitez contribuer à BabyModel, vous êtes les bienvenus ! Si vous tr
4747

4848
---
4949

50-
## Fonctionnalités 🌟
51-
52-
### 1. **DatabaseManager** 💾
53-
54-
Le `DatabaseManager` permet une gestion simplifiée des connexions à une base de données MySQL/MariaDB. Il inclut des fonctionnalités pour ouvrir et fermer des connexions à des bases de données, exécuter des requêtes SQL, et vérifier si des tables ou des colonnes existent.
55-
56-
**Principales fonctionnalités :**
57-
- Connexion à une base de données via JDBC.
58-
- Vérification de l'existence des tables et des colonnes.
59-
- Création et suppression de tables et de colonnes.
60-
- Exécution de requêtes SQL génériques.
61-
- Insertion de données dans une colonne spécifique.
62-
63-
Exemple d'utilisation :
64-
65-
```java
66-
import fr.babystaff.babymodel.dataBase.DataBase;
67-
import fr.babystaff.babymodel.dataBase.DataBaseManager;
68-
69-
DataBaseManager dbManager = new DataBaseManager();
70-
DataBase dataBase = new DataBase("localhost", "3306", "mydatabase", "user", "password");
71-
dbManager.openConnectionDataBase(dataBase);
72-
dbManager.createTable(dataBase, "players","id INT AUTO_INCREMENT, name VARCHAR(255), PRIMARY KEY(id)");
73-
dbManager.writeToColumn(dataBase, "players","name","Player1");
74-
```
75-
76-
### 2. **ActionBarManager** 🏷️
77-
78-
L'`ActionBarManager` permet d'afficher des messages dans l'ActionBar du joueur dans Minecraft. Il est conçu pour faciliter l'affichage de notifications temporaires ou dynamiques pendant le jeu.
79-
80-
**Principales fonctionnalités :**
81-
- Affichage de messages dans l'ActionBar pour un joueur spécifique.
82-
- Personnalisation des messages avec des couleurs et des styles.
83-
- Affichage de messages dynamiques basés sur des événements ou des actions spécifiques.
84-
85-
**Exemple d'utilisation :**
86-
87-
```java
88-
import fr.babystaff.babymodel.actionBar.ActionBarManager;
89-
90-
ActionBarManager actionBar = new ActionBarManager();
91-
actionBar.sendActionBarMessage(player, "Bienvenue sur le serveur!",5);
92-
```
93-
94-
### 3. **HologramManager**
95-
96-
Le `HologramManager` permet de créer et de gérer des hologrammes dans Minecraft. Il facilite l'affichage d'informations flottantes au-dessus du sol, idéal pour des messages interactifs, des affichages de statistiques ou d'autres éléments visuels.
97-
98-
**Principales fonctionnalités :**
99-
- Création d'hologrammes avec plusieurs lignes de texte.
100-
- Mise à jour dynamique du texte d'un hologramme.
101-
- Suppression d'hologrammes.
102-
- Gestion des positions des hologrammes.
103-
- Support pour les hologrammes interactifs (cliquables).
104-
105-
Exemple d'utilisation :
106-
107-
```java
108-
import fr.babystaff.babymodel.hologram.Hologram;
109-
import fr.babystaff.babymodel.hologram.HologramManager;
110-
111-
HologramManager hologramManager = new HologramManager();
112-
113-
// Créer un hologramme
114-
Hologram hologram = hologramManager.createHologram(player.getLocation().add(0, 2, 0), "Bienvenue sur le serveur!");
115-
116-
// Ajouter une ligne à l'hologramme
117-
hologram.
118-
119-
addLine("Votre rang : "+player.getRank());
120-
121-
// Mettre à jour l'hologramme
122-
hologram.
123-
124-
setLine(1,"Vous avez "+player.getCoins() +" pièces.");
125-
126-
// Supprimer l'hologramme
127-
hologram.
128-
129-
remove();
130-
```
131-
132-
### 4. World 🌍
133-
Le ``WorldManager`` permet de créer et de gérer des mondes dans Minecraft. Il facilite la création et suppression de monde.
134-
135-
```JAVA
136-
import fr.babystaff.babymodel.world.World;
137-
import fr.babystaff.babymodel.world.WorldManager;
138-
139-
WorldManager worldManager = new WorldManager();
140-
141-
// Créer un monde normal
142-
World newWorld = worldManager.createWorld("MonNouveauMonde", WorldType.NORMAL);
143-
if(newWorld !=null){
144-
System.out.
145-
146-
println("Le monde "+newWorld.getName() +" a été créé avec succès.");
147-
}
148-
149-
// Supprimer un monde
150-
boolean worldDeleted = worldManager.removeWorld("MonNouveauMonde");
151-
if(worldDeleted){
152-
System.out.
153-
154-
println("Le monde a été supprimé avec succès.");
155-
}else{
156-
System.out.
157-
158-
println("La suppression du monde a échoué.");
159-
}
160-
```
161-
162-
### 5. DiscordBot 🤖
163-
Le ``DiscordBotManager`` permet de crée et de modifier des bot Discords pour les intégrers au fonctionnalités en jeu, des fonctionnalités de base son intégré de ``JDA``
164-
165-
```JAVA
166-
import fr.babystaff.babymodel.discord.bot.DiscordBot;
167-
import fr.babystaff.babymodel.discord.bot.DiscordBotManager;
168-
169-
DiscordBotManager botManager = new BotManager();
170-
171-
// Créer et connecter un bot
172-
DiscordBot myBot = new DiscordBot("bot_token");
173-
botManager.
174-
175-
connectBot(myBot);
176-
177-
// Ajouter une commande
178-
CommandManager commandManager = new CommandManager();
179-
commandManager.
180-
181-
addCommand("!hello",(message) ->{
182-
System.out.
183-
184-
println("Bonjour ! Commande exécutée.");
185-
});
186-
187-
// Exécuter une commande
188-
commandManager.
189-
190-
executeCommand("!hello");
191-
```
192-
193-
### 6. Arena 🌱
194-
Le ``ArenaManager`` permet de créer et gérer des arènes et des joueurs dans ces arènes et monde
195-
196-
```JAVA
197-
import fr.babystaff.babymodel.arena.Arena;
198-
import fr.babystaff.babymodel.arena.ArenaManager;
199-
200-
ArenaManager arenaManager = new ArenaManager();
201-
202-
Location location = new Location(Bukkit.getWorld("world"), 0.5, 100, 0.5);
203-
Arena arena = new Arena("Arena", Bukkit.getWorld("world"), location);
204-
arena.
205-
206-
addPlayerInArena(player);
207-
```
208-
209-
### 7. Team 🚩
210-
Le ``TeamManager`` est une class qui permet de crée et de géré des équipes et les joueurs que les teams contiennent, les équipes sont ranger par couleur pour permettre de gérer des ``Game``
211-
212-
```JAVA
213-
import fr.babystaff.babymodel.team.Team;
214-
215-
// Création d'une équipe
216-
Team redTeam = new Team(ChatColor.RED, "red", "Red Team", 5);
217-
218-
// Ajouter des joueurs (exemple avec des objets Player fictifs)
219-
Player player1 = /* récupérer un joueur */;
220-
Player player2 = /* récupérer un autre joueur */;
221-
222-
if(redTeam.
223-
224-
addPlayer(player1)){
225-
System.out.println(player1.getName() +" a rejoint l'équipe "+redTeam.getName());
226-
} else {
227-
System.out.println("Impossible d'ajouter " + player1.getName());
228-
}
229-
230-
if(redTeam.addPlayer(player2)){
231-
System.out.println(player2.getName() +" a rejoint l'équipe "+redTeam.getName());
232-
}
233-
234-
// Afficher les informations de l'équipe
235-
System.out.println(redTeam);
236-
237-
// Supprimer un joueur
238-
redTeam.removePlayer(player1);
239-
240-
// Vider l'équipe
241-
redTeam.clearTeam();
242-
243-
// Vérifier l'état de l'équipe
244-
System.out.println("L'équipe est vide ? "+redTeam.getPlayers().isEmpty());
245-
```
246-
247-
### 8. Game 🎮
248-
Le ``GameManager`` permet de crée et de gérer des parties personnalisables, inclu la gestion de joueur et d'équipe
249-
250-
```JAVA
251-
import fr.babystaff.babymodel.game.Game;
252-
import fr.babystaff.babymodel.game.GameManager;
253-
254-
// Création d'une parti
255-
Game game = new Game("GameID", "Game Name", arena, location);
256-
257-
GameManager gameManager = new GameManager();
258-
gameManager.
259-
260-
createGame(game);
261-
262-
// Ajout d'un joueur
263-
gameManager.
264-
265-
addPlayer(player, game);
266-
267-
// Suppression d'un joueur
268-
gameManager.
269-
270-
removePlayer(player, game);
271-
```
272-
273-
### 9. NPC 🤖
274-
Il est aussi possible de crée des NPC et ```NPCManager```, il est possible de crée modifier et gérer des NPC dans le monde et leur ajouter des pratiques.
275-
276-
```JAVA
277-
import fr.babystaff.babymodel.npc.NPC;
278-
import fr.babystaff.babymodel.npc.NPCManager;
279-
280-
// initialisé NPC Manager
281-
NPCManager npcManager = new NPCManager();
282-
283-
// crée le npc
284-
NPC npc = new NPC(location, "Louis_292", skinTexute, skinSigniature, hologramManager);
285-
286-
// le supprime
287-
npc.delete();
288-
```
289-
290-
### 10. Langue 📨
291-
On peut égualement utiliser des messages traductions, des messages qui change en fonction de la 'langue' d'un joueur, grace à des messages garder dans des fichiers 'resources', tous ça grace à ``LanguageManager``
292-
293-
```JAVA
294-
import fr.babystaff.babymodel.langue.LanguageManager;
295-
296-
// initialisé Language Manager
297-
LanguageManager languageManager = new LanguageManager(getDataFolder());
298-
299-
// Récupère le message tradui du joueur
300-
String translation = languageManager.translate(player, "your_key");
301-
player.sendMessage(translation);
302-
```
50+
## [Wiki 📖](WIKI.md)

0 commit comments

Comments
 (0)