====== Développement du client de jeu IRIS ======
===== Principes de développement =====
Le client est envisagé comme comportant deux zones distinctes, le InGame and le OutGame, chacun placés dans la hiérarchie d’une node de ce nom dans la scène Main. Le InGame concerne tout ce qui nécessite la connexion à un serveur de jeu, et le OutGame, tout ce qui ne le nécessite pas. Bien que certains sytèmes soient partagés, comme les préférences (via le Global Settings), le jeu est soit dans un état, soit dans l’autre.

En InGame, il est prévu pour faire tourner [[https://en.wikipedia.org/wiki/Entity_component_system|une architecture de type ECS]], basée sur [[https://github.com/csprance/gecs|le plugin GECS]].


{{tag>godot client khanat mmorpg}}

===== La hiérarchie des dossiers =====
<mermaid>
treeView-beta
        "res:/ /"
            "autoloads"
            "data"
            "data_definition"
            "scenes"
                "widgets"
            "scripts"
            "scripts_template"
                "Node"
</mermaid>

==== autoloads ====
Dans ce répertoire sont enregistrés scènes et scripts des classes enregistrée comme //Globals// dans le projet.

==== data ====
Répertoire où sont stockés les assets, les Resources. Ce répertoire sera alimenté à l’avenir par un autre système, par le biais du Khreator, quand celui-ci sera effectif. Il s’agit de toutes les data nécessaires pour le jeu.

==== data_definition ====
Scripts servant à la création des classes de données du répertoire //data// et de tous les autres objets dérivés de la classe //Resource//.

==== scenes ====
Scènes utilisées pour le jeu, avec leur script lié s’il est unique. Le sous-répertoire accueille les widgets qui sont réutilisés de nombreuses fois.

==== scripts ====
Scripts qui ne sont liés ni à une scène //.tscn// ni héritant de la classe Resource.

==== scripts_template ====
[[https://docs.godotengine.org/en/stable/tutorials/scripting/creating_script_templates.html|Gabarits]] pour les scripts proposés automatiquement par Godot, afin d’aider à conserver toujours la même organisation.

Pour l’instant, seules la classe Node et celles qui en héritent proposent un gabarit //Custom organized Node script//.

===== Le système de son =====

Tout ce qui est audio dans le client est géré par un Global, une scène en autoload appelé AudioManager (''%%res://autoloads/audio_manager.gd%%'').

Pour le moment, il existe 5 bus pour le son:
  - Master, qui se superpose aux 4 autres, pour la gestion générale. Il ne reçoit aucun flux direct, seulement les quatre autres.
  - Music, qui gère la musique non diégétique.
  - Gui, qui propose les sons d’interface.
  - SFX, qui s’occupe des sons émis par les éléments 3D avec une spatialisation de leur émission (position et direction).
  - Ambient, qui s’occupe des sons qui sont présents dans une zone 3D sans avoir un point précis d’émission.

Chaque sous-sytème est une node fille du système de gestion général.

{{ :fr:mmorpg:client:iris:screen_capture_20260618_094758.jpg?direct&500 |}}

Ces sous-systèmes proposent chacun un certain nombre de paramètres pour gérer le sound design:

 {{ :fr:mmorpg:client:iris:screen_capture_20260618_095013.jpg?direct&600 |}}
  * Bus Name: le nom du bus qui gérera les sons émis par ce manager
  * Pool size: le nombre de MediaPlayer simultanés qui seront utilisés par ce manager
  * Cache size : le nombre de Resources stockées en cache parmi les plus fréquemment appelées
  * Use 3D: pour différencier les systèmes placés dans l’espace de jeu 3D de ceux qui ne le sont pas
  * Sound Path: le répertoire où les Resources utilisées par ce système sont placées

Depuis le code, pour émettre un son, il suffit d’appeler le submanager audio dédié et le nom de fichier de la Resource à émettre (sans son suffixe) et le son sera pris en charge. Pour le moment, seuls les sons d’interface (gui) sont implémentés correctement et la musique de façon minimale.

Exemples:

Pour émettre un son de click, indiquer:
<code>
AudioManager.gui.play_sound("ui_click")
</code>

Pour lancer le thème principal du jeu:
<code>
AudioManager.music.play_sound("main_theme")
</code>

===== L’interface =====

Le système de préférences ’géré par le Global Settings (''%%res://autoloads/settings.gd%%'') intègre la gestion du thème qui définit les différents éléments d’affichage.

==== Les icônes du thème ====

Les icônes sont définies dans la sous section **GuiIcons**, dans la section **Theme** dédiée au thème dans les presets (ceux par défault créé à l’origine sont créés à partir de la Resource SettingsPreset situé à ''%%res://data/settings/settings_default.tres%%''

{{ :fr:mmorpg:client:iris:screen_capture_20260618_101059.jpg?direct&600 |}}

Les éléments à indiquer sont:
  * Texture File: le fichier .svg où sont les icônes, organisées selon une grille et un ordre précis (voir plus bas)
  * Grid Module : la taille (en pixels) de la grille qui organise les différentes icônes dans le fichier
  * Columns Amount : le nombre de colonnes dans le fichier.

Avec ces informations, le Global GuiMedia(''%%res://autoloads/gui_media.gd%%'') va aller chercher dans le fichier les appels qui lui sont faits depuis le code pour indiquer la bonne icône d’interface pour le thème choisi.

L’ordre dans lequel les icônes sont disposées est crucial, car le système ira les chercher dans l’ordre indiqué par l’enum ''%%GuiMedia.Icon%%''. C’est ce qui permet pour les appels depuis les nodes Control de simplement écrire :

<code>
Button.icon = GuiMedia.get_gui_icon(GuiIcon.Icon.GO_LEFT)
</code>

pour obtenir la flêche indiquant vers la gauche

===== L’interface OutGame =====

Une scène (''%%res://scenes/lobby.tscn%%'') gère le menu principal de navigation.