You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,29 +15,29 @@ A GUI framework for the Spring Engine. For support, MasterBel2 can be contacted
15
15
16
16
### Installation
17
17
18
-
Copy/symlink `gui_master_framework_42.lua` to your Spring installation's `LuaUI/Widgets/` folder, and the `MasterFramework 42` folder to your `LuaUI/` folder, forming the path `LuaUI/MasterFramework 42/`.
18
+
Copy/symlink `gui_master_framework_dev.lua` to your Spring installation's `LuaUI/Widgets/` folder, and the `MasterFramework Dev` folder to your `LuaUI/` folder, forming the path `LuaUI/MasterFramework Dev/`.
19
19
20
20
As a result, your LuaUI directory should look like this:
21
21
```
22
22
LuaUI/
23
-
MasterFramework 42/
23
+
MasterFramework Dev/
24
24
Widgets/
25
-
gui_master_framework_42.lua
25
+
gui_master_framework_dev.lua
26
26
...
27
27
...
28
28
```
29
29
30
-
Once installed, make sure you enable `MasterBel2's GUI Framework (42)` in Widget Selector. See [below](#Using-MasterFramework-to-build-your-UI) for how to use MasterFramework in your project.
30
+
Once installed, make sure you enable `MasterBel2's GUI Framework (Dev)` in Widget Selector. See [below](#Using-MasterFramework-to-build-your-UI) for how to use MasterFramework in your project.
31
31
32
32
### Importing MasterFramework
33
33
34
-
MasterFramework supports multiple installed versions, available in the table `WG.MasterFramework` after the widget handler calls `widget:Initialize()` on the framework.
35
-
The framework version number is the table key for the instance of MasterFramework; e.g. MasterFramework 42 can be accessed via `WG.MasterFramework[42]`.
34
+
MasterFramework supports multiple installed versions, available in the table `WG` after the widget handler calls `widget:Initialize()` on the framework.
35
+
`MasterFramework Dev`is stored under `WG["MasterFramework Dev"]`.
Some brief notes on the internal code of MasterFramework (i.e. within the `MasterFramework 42/` folder):
163
+
Some brief notes on the internal code of MasterFramework (i.e. within the `MasterFramework Dev/` folder):
164
164
165
-
- The global environment (also the `framework` entry in the global environment) refers to the framework itself, that is registered in `WG.MasterFramework[42]`.
165
+
- The global environment (also the `framework` entry in the global environment) refers to the framework itself, that is registered in `WG["MasterFramework Dev]"`.
166
166
- A table `Internal` is provided in the global environment during framework initialisation only; this should be cached if needed. Post initialisation, it is removed from the global environment, to restrict access to users of the framework.
167
167
- A table `Include` is provided in the global environment during framework initialisation only; this provides access to a portion of the standard global environment. This is also removed post-initialisation, to reduce unneccessary clutter.
168
168
- Code is loaded in an unpredictable order; avoid top-level code in these files if at all possible. Instead, provide any necessary initialisation in [https://github.com/MasterBel2/Master-GUI-Framework/tree/main/gui_master_framework_42.lua] after the contents of [https://github.com/MasterBel2/Master-GUI-Framework/tree/main/MasterFramework%2042] have been loaded.
0 commit comments