Snippets of Lua that you can include in CC projects. These are available under the permissive MIT license, so feel free to fork, send pull requests and include in your own Lua projects. The only requirement is that you credit me. This excludes ccConfig, owned by theoriginalbit. The license is at the top of ccConfig. I'm just putting it here to host it, so it is available on packman.
require is designed to be easily incorporated into the top of a CC program. In this case, simply insert the code (smaller, minified code is available in releases) at the top of your program, ensuring the license is kept as a comment. This code will work in most recent versions of ComputerCraft, and with some modification, in generic Lua.
The files are stored on the repository as .lua files. This is not the case for computercraft programs, so you will either have to remove the extension or download the release, which includes the programs without the extensions. Some of my other snippets can easily be downloaded (through a release or through Packman) and added to your programs using require() or lib().
You can now use Packman, a package manager that is included in LyqydOS, to install my programs.
Simply update your version of packman: packman fetch (If it gives an error, run it again. If that doesn't work, check your 'net connection and http api settings.) and install a program using packman install <program>.
To update your packman programs, run packman fetch update.
To add require to your programs, see below.
Also available on CC forums here when I update it.
This snippet provides a require() function, very similar to CommonJS AMD module loading.
module1, module2, module3... = require(location1, location2, location3...)
This function takes the location of a lua file/module and gives you the namespace for that module. It uses os.loadAPI, so you do not have to modify APIs to use them. You can include as many modules at once, or just one. It is easy to use and only around 420B when minified. This snippet is designed to be inserted at the top of a file.
By default require() (and by extension lib()) searches in the following locations:
- /usr/apis/[name]
- /[name]
- shell.resolveProgram([name])
Requires ComputerCraft 1.63 or newer - See above for newer version
This snippet provides a require() function, very similar to CommonJS AMD module loading.
module1, module2, module3... = require(location1, location2, location3...)
This function takes the location of a lua file/module and gives you the namespace for that module. It uses os.loadAPI, so you do not have to modify APIs to use them. You can include as many modules at once, or just one.
It is easy to use and only around 600B when minified. This snippet is designed to be inserted at the top of a file.
To find a module, specify it with no trailing slash (relative) and require() will look in the current directory and all directories above the current directory. If you include a trailing slash (absolute), require() will only look in the directory you specify.
ComputerCraft 1.63 is required for the fs.getDir function, but if you do want to use it for earlier versions, you could write a replacement for fs.getDir, or find one.
btn = require("button") -- Includes the button api
btn.heading("Hello!") -- A function of the button api, adds a heading on an attached monitor
t = require("touchpoint").new() -- Includes the touchpoint api and creates a new instance of buttons, discarding the touchpoint api reference
t:add(...) -- Adds buttons
t:draw() -- Draws buttons
disk = require(disk.getMountPath("left") .. "randomapi") -- Includes an api from the disk attached to the left
disk.random()
The packman package for this snippet is require.
This is a simple program that makes it easy to add require to a program. Simply install it then run it for each of your files:
addrequire <file1> [file2] [file3] ...
The packman package for this snippet is addrequire.
It depends on require, so it will automatically be installed when you install addrequire.
Also available on CC forums here once I have edited it.
This snippet provides a lib() function, very similar to CommonJS AMD module loading.
module1, module2, module3... = lib(location1, location2, location3...)
This function takes the name of a lua file/module and gives you the namespace for that module. It uses os.loadAPI, so you do not have to modify APIs to use them. You can include as many modules at once, or just one. It is easy to use and only around 900B when minified. This snippet is designed to be inserted at the top of a file. Simply specify the API's name, and it should be found. If it can't be found and the user has a http connection and a package manager, lib will ask the user if they want to try and install the API. In the future lib will also support direct loading from pastebin.
btn = lib("button") -- Includes the button api
btn.heading("Hello!") -- A function of the button api, adds a heading on an attached monitor
t = lib("touchpoint").new() -- Includes the touchpoint api and creates a new instance of buttons, discarding the touchpoint api reference
t:add(...) -- Adds buttons
t:draw() -- Draws buttons
The packman package for this snippet is lib.
- Make new replacement for addrequire called addcode, that supports adding api code/require/lib to the top or bottom of your programs