epicknex/multi
1
0
Fork 0
mirror of https://github.com/rayaman/multi.git synced 2026-09-05 07:27:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Getting Started (markdown)

server
2018-06-10 22:09:02 -04:00
parent a7bd533d1c
commit e8d542ec48
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Getting-Started.md
+7 -3
@@ -4,10 +4,14 @@ Setting up the library is simple. To setup simply copy the folder multi into you
```lua ```lua
package.path="?/init.lua;"..package.path package.path="?/init.lua;"..package.path
-- Then require like normal -- Then require like normal
require("multi.all") -- loads the library and all of the separate objects require("multi") -- loads the library and all of the separate objects
```
I recently added the modules to the system in the way they are now. Before everything was thrown into one lua file called **multiManager.lua** however this makes debugging harder and I didn't like that the requiring name was "multiManager" and the namespace was multi. This is why I changed it to multi for ease of debugging and to keep things consistent. This does however mean that the multi library has to be Global so each module can modify and add to it. --or if you want to use system threading then you can do this
local GLOBAL, THREAD = require("multi.integration.lanesManager") -- when using lanes
GLOBAL, THREAD = require("multi.integration.loveManager") -- when within the love2d engine
require("multi.integration.luvitManager") -- when using luvit framework
```
This also means that require does not return a handle for the library, instead the global environment is modified. This however is not a problem though. This also means that require does not return a handle for the library, instead the global environment is modified. This however is not a problem though.