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

Updated Getting Started (markdown)

server
2017-06-14 14:43:18 -04:00
parent 935992fa34
commit 47941301a1
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Getting-Started.md
+14 -1
@@ -1 +1,14 @@
...
# Getting Started
Setting up the library is simple. To setup simply copy the folder multi into your lua environment. Depending on how your path settings are set up you may need to add this line at the top of your code:
```lua
package.path="?/init.lua;"..package.path
-- Then require like normal
require("multi.all") -- 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.
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.
After requiring the library you may want to create predefined objects or create your own to run side by side and have all of the features that make this library powerful. For a list of objects and how to use them take a look at the [Objects]() page.