Clone
4
Getting Started
Ryan Ward edited this page 2018-06-10 22:09:02 -04:00

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:

package.path="?/init.lua;"..package.path
-- Then require like normal
require("multi") -- loads the library and all of the separate objects

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

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. This page will contain all of the information pertaining to object creation and manipulation.