PRs are welcome to this project, I hope the documentation is clear enough, but if you have any questions feel free to ask.
This documentation is also available at misc.madefor.cc
The directory structure of this project is as follows
clients/client programs and librariesmodules/all ready to use modulesrecipes/all vanilla grid recipes stored in custom binary formatsuspended/modules which development has been suspended oncommon.luacommon library file (that should be split up in the future)abstractInvLib.lualocal copy ofabstractInvLib.luato ease development, will eventually be removedstorage.luaentrypoint and module loader
A minimal MISC system consists of
- A single computer running MISC
- Any number of connected inventories
- (Optionally) A client access terminal
To install MISC, you can simply run the installer on your server and each client you'd like to use.
wget run https://raw.githubusercontent.com/MasonGulu/CC-MISC/master/installer.lua.
Functionality can be extended by attaching more devices to the network, and adding appropriate modules. For example, grid crafting functionality can be added by adding the following modules.
- Crafting planner and executor
/modules/crafting.lua - Grid crafting provider
/modules/grid.luaYou'll need some recipes, you can start with/recipes/*.
Then adding as many crafty turtles running /clients/crafter.lua as you'd like.
To install the MISC server, you will need the following files.
- The main executable,
storage.lua - The modules you'd like in
/modules/, (/modules/inventory.luais required)- Module load order is determined automatically based on each module's dependencies list. For more information see the general module documentation.
- The shared library,
common.lua abstractInvLib.luaFor ease of development there is currently a copy in this repository.
To install the MISC terminal, attach a turtle to your MISC network and install the following files. These can both be installed to the root of the drive.
- The terminal executable
clients/terminal.lua - The generic modem interface library
clients/modem_lib.lua
You'll also require a few additional modules on the MISC server
- Generic interface handler
/modules/interface.lua - Modem interface protocol
/modules/modem.lua
Look in /docs/ for development and module specific documentation.