-- Manis_TestFramework/MODPORTAL_DESCRIPTION.md
(en)
Manis Test Framework is a lightweight runtime verification framework for Factorio mods.
This is NOT a gameplay mod.
It provides a simple way to run deterministic, repeatable checks inside the game runtime and export results.
■ Features
- Run test suites via commands
- Output results to:
- in-game chat
- factorio-current.log
- script-output (file output)
- Minimal assertions (assert / assert_eq)
- Suite-based structure (multiple named tests)
■ How to use
This framework does nothing by itself.
Each mod must explicitly:
- require Manis Test Framework
- define its own test suites
- register its own commands
See the GitHub README for exact usage examples.
https://github.com/suumani/Manis_TestFramework/blob/main/README.md
■ Notes
- This framework is designed for command-driven tests (manual trigger).
- It does not run automatically in the background.
A small sample suite is included as a reference.
(ja)
Manis Test Framework は、Factorio Mod向けの 実行時検証(Runtime Verification)フレームワークです。
これはゲーム内容を追加するModではありません。
ゲーム内で再現可能なチェックを実行し、結果を保存するためのツールです。
■ 機能
- コマンドでテストスイートを実行
- 結果を以下へ出力:
- ゲーム内チャット
- factorio-current.log
- script-output(ファイル出力)
- 最小限のアサーション(assert / assert_eq)
- スイート形式(複数テストをまとめて実行)
■ 使い方(How to use)
この Mod は単体では何も実行しません。
各 Mod 側で以下を明示的に行う必要があります:
- Manis Test Framework を require する
- テストスイートを定義する
- 独自のコマンドを登録する
具体例は GitHub の README を参照してください。
https://github.com/suumani/Manis_TestFramework/blob/main/README.ja.md
■ 注意
- 本フレームワークは コマンド実行型です(手動トリガー)。
- 自動で常時テストを走らせる設計ではありません。
参考として、サンプルのテストスイートを同梱しています。