RitnLib

by Ritn

Function library for Ritn Mod.

Internal
8 days ago
0.17 - 2.0
124K

Changelog

Version: 0.10.1
Date: 21.06.2026
  Bugfixes:
    - Fixed minor code errors RitnSetting type constants.
Version: 0.10.0
Date: 14.06.2026
  Info:
    - Documentation: restructured docs/ for MkDocs i18n plugin (suffix strategy, FR default + EN alternate). Added GitHub Pages workflow (.github/workflows/docs.yml) with mkdocs-material + mkdocs-static-i18n. All 100+ docs files migrated from docs/fr/ + docs/en/ to docs/**/*.md + docs/**/*.en.md. Fixed all internal links. Added stubs for planned guides, concepts, ADRs, and debt pages.
    - Updated README: documentation links now point to https://ritndev.github.io/RitnLib/
Version: 0.9.14
Date: 14.06.2026
  Info:
    - Documentation: added bilingual (EN/FR) reference pages for all utility modules: lualib (json, string, table, other, entity, gui, LuaStyle functions), core layer (class-factory, constants, event-listener, interfaces), ritnlib.defines registry, vanilla helpers (util, crash-site, ores, types), and a beta stub for RitnLibInformatron.
Version: 0.9.13
Date: 14.06.2026
  Info:
    - Documentation: added the full bilingual (EN/FR) Tier 1 class reference (~27 classes), styled like the Factorio runtime API docs (attributes, methods, parameters, return values, real usage examples from consumer mods). Covers the runtime wrappers (Event, Player, Surface, Force, Recipe, Technology, Entity, Gui, Inventory), the GUI builders (GuiElement, Style), the data-stage prototype manipulators (RitnPrototype base, RitnIngredient and every RitnProto* class), and a work-in-progress stub for RitnLibSetting.
    - Fixed dead links in the documentation index (RitnProtoTechnology -> RitnProtoTech).
Version: 0.9.12
Date: 14.06.2026
  Info:
    - Documentation: added bilingual (EN/FR) class : RitnLibEvent, RitnLibForce, RitnLibGui and RitnLibPlayer.
  Scripting:
    - Delete: saveLogistic() and loadLogistic() on RitnInventory class.
Version: 0.9.11
Date: 14.06.2026
  Info:
    - Documentation: added bilingual (EN/FR) class reference map (reference/overview), known-bugs and Factorio 2.0 migration debt pages, and the first ADR (0001 - in-house class factory).
  Scripting:
    - LuaLS annotations: corrected false "broken/P0" notes carried over from the audit, verified against the consumer mods (comments only, no behaviour change). RitnLibGui methods are documented as an extension contract; RitnLibForce getStats* reframed as the 1.x statistics API pending the 2.0 migration; dropped the wrong "removed in 2.0" note on LuaForce.items_launched/rockets_launched (still present in 2.0); RitnLibEvent created_entity flagged as a 1.x residue (on_trigger_created_entity).
Version: 0.9.10
Date: 12.06.2026
  Scripting:
    - Added LuaLS (EmmyLua) annotations to every class and module: typed fields, params, returns and call signatures, with bilingual EN/FR descriptions shown in IDE tooltips.
    - Added types/ritnlib-globals.lua meta file (shipped in the mod zip). Consumer mod developers can add the RitnLib/types folder to their .luarc.json workspace.library to get full autocomplete on RitnLib globals (RitnLibPlayer, RitnLibEvent, ...).
  Bugfixes:
    - Fixed minor code errors found during the annotation pass (RitnIngredient.getItem, RitnSetting type constants).
  Info:
    - Added .luarc.json (LuaLS workspace config, dev only - excluded from the mod zip).
    - Updated .gitattributes: dev-only files excluded from releases; types/ folder now shipped.
Version: 0.9.9
Date: 11.06.2026
  Info:
    - Added : /docs
    - Initial documentation files added: architecture, index, getting-started, concepts...
  Changes:
    - Updated README.md
Version: 0.9.8
Date: 09.06.2026
  Changes:
    - Updated release workflow (GitHub Actions: tag-driven publish to Factorio Mod Portal).
Version: 0.9.7
  Changes:
    - Renamed player/surface getters to get_player() and get_surface() on RitnLibEvent.
Version: 0.9.6
  Features:
    - Added self.isPresent property on all wrapper classes (e.g. RitnSurface, RitnPlayer, RitnForce, RitnEntity, RitnRecipe, RitnTechnology). Lets consumers test wrapper validity without nil-checking every field.