RitnLib

Classes and functions library for Ritn Factorio mods.

---

Get started

New here? Start with:

• 📦 Getting started — install + first mod in 5 minutes
• 🧩 The 4-layer architecture — how the mod is organized
• ⚠ Temporary wrappers golden rule — read before using runtime classes

Guides

Task-oriented tutorials:

• Installation
• Your first prototype
• Your first runtime handler
• Complete GUI pattern
• Inventory snapshot & restore
• Building a setting
• Remote interfaces

Class reference

Overview

• Class map
• ritnlib.defines registry

Runtime classes (control stage)

Class	Wraps	Use
RitnLibEvent	any Factorio event	payload normalization
RitnLibPlayer	LuaPlayer	fast access
RitnLibSurface	LuaSurface	entity search
RitnLibForce	LuaForce	recipes/techs/stats
RitnLibEntity	LuaEntity	entity manipulation
RitnLibRecipe	LuaRecipe	runtime activation
RitnLibTechnology	LuaTechnology	research-finished hook
RitnLibInventory	LuaPlayer + storage	snapshot/restore
RitnLibGui	GUI event	click dispatcher
RitnLibInformatron	Informatron event	page integration
RitnLibGuiElement	add{...} payload	fluent builder
RitnLibStyle	LuaStyle	style presets

Data classes (data stage)

Class	Manipulates
RitnPrototype	base of all manipulators
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	ingredient normalization

Settings stage

• RitnLibSetting

Utility libraries

• lualib/other-functions
• lualib/table-functions
• lualib/string-functions
• lualib/json-functions — embeds rxi/json.lua (MIT)
• lualib/entity-functions
• lualib/gui-functions
• lualib/LuaStyle-functions ⚠ deprecated

Vanilla helpers

• lualib/vanilla/util
• lualib/vanilla/crash-site
• lualib/vanilla/ores
• lualib/vanilla/types

Foundation layer

• core/class.lua — Object-oriented class factory
• core/constants.lua
• core/eventListener.lua — fork ⚠ experimental
• core/interfaces.lua

Concepts

• 4-layer architecture
• Life cycle (data → settings → control)
• Temporary wrappers (golden rule)
• Custom object-oriented class factory
• Event model
• Delegated persistence
• Consumer remote contract

Architecture decisions (ADR)

• ADR index
• ADR-0001 — Custom object-oriented class factory
• ADR-0002 — _G globals vs returned modules
• ADR-0003 — Status of the eventListener fork
• ADR-0004 — FR + EN language strategy

Debt & migration

• 🐛 Known bugs
• 🕰 1.x API leftovers
• ⚠ Deprecated APIs
• 🔧 Factorio 2.0 migration

For maintainers

• 🏗 Internal architecture (FR only)