Commencer
Comprendre le SDK
Choisissez une API pour créer des signaux, des outils en jeu ou une application connectée.
Du comportement au résultat visible
Le SDK permet de décrire un signal et ses règles, d’ajouter un outil au jeu ou de consulter une partie depuis une application Kotlin. Ce manuel part de ces résultats : il présente les données disponibles, les opérations autorisées et la manière de vérifier votre projet. Quelques bases de Kotlin suffisent pour commencer le premier signal.
Vous choisissez les indications, les vitesses, les images, les réglages et les règles métier. Le SDK fournit les observations et les fonctions de haut niveau qui appliquent vos décisions. Une information inconnue doit rester inconnue ; votre modèle définit explicitement son comportement de repli.
Choisir le bon point d’entrée
| Votre projet | API | Point de départ |
|---|---|---|
| Mod de signalisation | nimby · Kotlin/Native | signalModel → signalMod → createMod |
| Outil avec boutons et panneaux dans le jeu | nimby · Kotlin/Native | toolMod → ToolContext |
| Application externe : supervision, analyse ou test | fr.nimby.sdk · Kotlin/JVM | Nimby.connect → Game |
Les deux API Kotlin ont des types distincts. Un outil intégré au jeu utilise nimby, comme un mod de signaux. Une application externe utilise fr.nimby.sdk, ouvre sa connexion et la ferme lorsqu’elle a terminé. Consultez toujours l’étiquette Native ou JVM de la référence avant de copier un import.
Les bases Kotlin utilisées dans les exemples
| Écriture | Lecture |
|---|---|
| val | Une référence que l’on ne réaffecte pas. |
| fun | Une fonction avec des paramètres et un résultat. |
| enum class | Des valeurs nommées pour vos indications ou motifs. |
| data class | Des propriétés regroupées, avec copie explicite par copy(). |
| Type? | Une valeur qui peut être absente : null. |
| when | Choisir un résultat selon les conditions. |
| List<Type> | Une collection d’éléments du même type. |
| { … } | Une configuration ou un bloc de comportement transmis à une fonction. |