Skip to content

Commit 352c9d4

Browse files
committed
Update version number in README
1 parent dc019ee commit 352c9d4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ A GUI framework for the Spring Engine. For support, MasterBel2 can be contacted
1515

1616
### Installation
1717

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/`.
1919

2020
As a result, your LuaUI directory should look like this:
2121
```
2222
LuaUI/
23-
MasterFramework 42/
23+
MasterFramework Dev/
2424
Widgets/
25-
gui_master_framework_42.lua
25+
gui_master_framework_dev.lua
2626
...
2727
...
2828
```
2929

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.
3131

3232
### Importing MasterFramework
3333

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"]`.
3636
See the example below:
3737

3838
```lua
3939
local framework
40-
local requiredFrameworkVersion = 42
40+
local requiredFrameworkVersion = "Dev"
4141

4242
widget:Initialize()
4343
MasterFramework = WG["MasterFramework " .. requiredFrameworkVersion]
@@ -130,7 +130,7 @@ function widget:GetInfo()
130130
end
131131

132132
local MasterFramework
133-
local requiredFrameworkVersion = 42
133+
local requiredFrameworkVersion = "Dev"
134134

135135
local key
136136

@@ -160,9 +160,9 @@ end
160160

161161
## Contributing to MasterFramework
162162

163-
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):
164164

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]"`.
166166
- 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.
167167
- 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.
168168
- 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

Comments
 (0)