RitnLib¶
Bibliothèque de classes et fonctions pour les mods Factorio de Ritn.
Démarrer¶
Nouveau venu ? Commence par :
- 📦 Démarrer avec RitnLib — installation + premier mod en 5 minutes
- 🧩 Architecture en 4 couches — comment le mod est organisé
- ⚠ Règle d'or des wrappers temporaires — à lire avant d'utiliser les classes runtime
Guides¶
Tutoriels orientés tâche :
- Installation
- Mon premier prototype
- Mon premier handler runtime
- Pattern GUI complet
- Snapshot et restauration d'inventaire
- Construire un setting
- Interfaces remote
Référence des classes¶
Vue d'ensemble¶
Classes runtime (control stage)¶
| Classe | Wrappe | Usage |
|---|---|---|
RitnLibEvent |
n'importe quel event Factorio | normalisation de payload |
RitnLibPlayer |
LuaPlayer |
accès rapide |
RitnLibSurface |
LuaSurface |
recherche d'entités |
RitnLibForce |
LuaForce |
recettes/techs/stats |
RitnLibEntity |
LuaEntity |
manipulation entité |
RitnLibRecipe |
LuaRecipe |
activation runtime |
RitnLibTechnology |
LuaTechnology |
hook fin de recherche |
RitnLibInventory |
LuaPlayer + storage |
snapshot/restore |
RitnLibGui |
event GUI | dispatcher de clic |
RitnLibInformatron |
event Informatron | intégration page |
RitnLibGuiElement |
payload add{...} |
builder fluent |
RitnLibStyle |
LuaStyle |
presets de style |
Classes data (data stage)¶
| Classe | Manipule |
|---|---|
RitnPrototype |
base de tous les manipulateurs |
RitnProtoEntity |
data.raw[entity-type] |
RitnProtoItem |
data.raw[item-type] |
RitnProtoRecipe |
data.raw.recipe |
RitnProtoTech |
data.raw.technology |
RitnProtoOre |
data.raw.resource + autoplace |
RitnProtoSprite |
data.raw.sprite |
RitnProtoStyle |
data.raw['gui-style'] |
RitnProtoItemGroup |
data.raw['item-group'] |
RitnProtoItemSubgroup |
data.raw['item-subgroup'] |
RitnProtoRecipeCategory |
data.raw['recipe-category'] |
RitnProtoFuelCategory |
data.raw['fuel-category'] |
RitnProtoCustomInput |
data.raw['custom-input'] |
RitnProtoUtilityConst |
data.raw['utility-constants'] |
RitnIngredient |
normalisation d'ingrédient |
Settings stage¶
Bibliothèques utilitaires¶
lualib/other-functionslualib/table-functionslualib/string-functionslualib/json-functions— embarque rxi/json.lua (MIT)lualib/entity-functionslualib/gui-functionslualib/LuaStyle-functions⚠ déprécié
Vanilla helpers¶
Couche fondation¶
core/class.lua— factory de classes orientée objetcore/constants.luacore/eventListener.lua— fork ⚠ statut expérimentalcore/interfaces.lua
Concepts¶
- Architecture en 4 couches
- Cycle de vie (data → settings → control)
- Wrappers temporaires (règle d'or)
- Factory de classes orientée objet maison
- Modèle d'events
- Persistance déléguée
- Contrat remote consommateur
Décisions d'architecture (ADR)¶
- Index des ADR
- ADR-0001 — Factory de classes orientée objet maison
- ADR-0002 — Pollution
_Gvs modules retournés - ADR-0003 — Statut du fork
eventListener - ADR-0004 — Stratégie linguistique FR + EN
Dette et migration¶
Pour les mainteneurs¶
- 🏗 Architecture interne (FR uniquement)