mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-11-17 22:33:13 +09:00
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:
1 parent
8e7ac3c872
commit
8d7d5ff10f
14 files changed
+586
-7
No files matched your search
@@ -442,7 +442,7 @@ If a state argument is not given then this becomes `toggle_button_toggled_state`
|
||||
This method does not raise `on_click`; instead, it raises `on_button_toggled`
|
||||
|
||||
```lua
|
||||
Gui.toolbar.set_button_toggled_state(Elements.toggle_me, true)
|
||||
Gui.toolbar.set_button_toggled_state(Elements.toggle_me, player, true)
|
||||
```
|
||||
|
||||
### `Gui.toolbar.set_left_element_visible_state`
|
||||
@@ -453,5 +453,5 @@ If a state argument is not given then this becomes `toggle_left_element_visible_
|
||||
When a toolbar button is linked, this method also raises `on_button_toggled` for that button to reflect the change.
|
||||
|
||||
```lua
|
||||
Gui.toolbar.set_button_toggled_state(Elements.my_frame, true)
|
||||
Gui.toolbar.set_left_element_visible_state(Elements.my_frame, player, true)
|
||||
```
|
||||
@@ -180,7 +180,7 @@ The returned tupple is `LuaPlayer, LuaGuiElement`.
|
||||
This method is named "filtered" because it is expected that the player list provided has been filtered on some condition and only elements for players in this list are returned.
|
||||
The optional third argument can be provided to filter to online only if you have not done so yourself.
|
||||
|
||||
### `GuiIter.all_element`
|
||||
### `GuiIter.all_elements`
|
||||
|
||||
Iterates all elements for all players in a given scope.
|
||||
The returned tupple is `LuaPlayer, LuaGuiElement`.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in new issue
Block a user