Add a readme to every plugin and list them in the main readme (#505)

Commands, Permission Groups, Player Statistics, Reports, Roles, Scenario,
Server UPS and Module Utilities get a readme covering their config,
permissions, commands, web pages and Lua and Node API.

The existing readmes are brought up to date: Auto Restart now that
clusterio marks a restart after a plugin install, Discord Auth gets the
code timeout, command aliases and its Lua API, and the GUI guide says what
the plugin is and has its toolbar examples and an iterator name fixed.

The main readme gets a Plugins section listing each plugin by name and
package with a one line description.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
BastiaanandClaude Opus 5.5 authored and GitHub committed 2026-10-15 23:12:48 +01:00
1 parent 8e7ac3c872
commit 8d7d5ff10f
14 files changed
+586 -7

No files matched your search

+2
View File
@@ -1,5 +1,7 @@
# ExpGui Framework Guide
ExpGui is a Clusterio plugin that patches the `exp_gui` module into the save. The module is a Lua library for defining Factorio GUIs, and other modules load it with `require("modules/exp_gui")`. It depends on the `exp_util` module. The plugin has no config, permissions or Node messages.
This guide presents best practices for creating GUIs in Factorio and demonstrates how the ExpGui framework can help streamline development.
If you’re new to GUI creation in Factorio, we recommend starting with [Therenas' helpful tutorial](https://github.com/ClaudeMetz/UntitledGuiGuide/wiki) to build a solid foundation.
We also recommend [Raiguard's style guide](https://man.sr.ht/~raiguard/factorio-gui-style-guide/) if you are looking to mimic the design principles employed by the game's own guis.