Créer des mods pour NeoPiano

NeoPiano est conçu pour être étendu. Les mods peuvent ajouter des interfaces qui ont l’air natives, des effets de notes, des scènes, des réglages, des outils d’apprentissage et même des modes de jeu : Jouer ensemble, le mode en ligne de NeoPiano, est lui-même un mod.

Trois façons de modder

Lua 5.4

Un script texte déclaré dans le .uplugin. Pas d’éditeur Unreal, pas de compilation, rechargement à chaud. Le meilleur point de départ.

WebAssembly

Du C ou du C++ compilé en un .wasm de quelques kilo-octets, avec le script et l’en-tête fournis. Un seul fichier pour Windows et macOS.

Blueprint et contenu

Matériaux, Niagara, scènes, sons et Blueprints créés dans l’Unreal Engine 5.8 du Launcher, avec le SDK NeoPiano, puis cuits en paquet.

Un même mod peut combiner du contenu (Blueprint, matériaux) et du code (Lua ou WebAssembly).

Une seule API, trois langages

Toutes les fonctions de l’API neo existent en Lua, en WebAssembly et en nœud Blueprint, avec exactement les mêmes pouvoirs. Le mod manipule des identifiants (de widget, d’entité…) que NeoPiano vérifie à chaque appel, jamais des pointeurs.

Les principes

• Interface déclarative. Votre mod décrit son interface (un arbre de composants) et NeoPiano la dessine avec ses propres composants et son thème. Votre mod a l’air natif sans effort, et ne peut pas casser le style de l’application.
• Capacités déclarées. Le .uplugin liste ce que le mod utilise. Le joueur le voit avant d’activer le mod, et tout appel hors capacités est refusé. Voir Capacités.
• Budgets. Chaque appel et chaque image ont un budget de temps, partagé entre les mods. Voir Sandbox et budgets.
• Compatibilité. L’API ne fait que s’enrichir : un mod écrit aujourd’hui continue de marcher demain. Voir Compatibilité et versions.

Note

Versions actuelles : API neo 2 et API de mod 5. La feuille de route indique ce qui est disponible et ce qui arrive.

Par où commencer

Votre premier mod LuaDe zéro à un mod qui réagit à vos notes, en dix minutes.

Anatomie d’un modLe dossier, le .uplugin, les scripts et le contenu.

Interface déclarativePanneaux, HUD, toasts et composants.

Référence de l’APIToutes les fonctions, leur capacité et leur statut.