ComputerCraft Libs

Helper functions and programs for computers and turtles.

• CC:Tweaked Wiki
• Computer Craft Wiki

Usage

This repo includes two helper scripts to install the library and apps from the latest release. The fastest way to get started is downloading one of these scripts on a turtle or computer using wget and running it to install. If the library or apps are already installed, the script will update them to the latest release.

Library

The library install script install_cc-libs.lua, can be found under the install folder.

wget https://raw.githubusercontent.com/twh2898/cc-libs/refs/heads/main/install/install_cc-libs.lua

Apps

The apps install script install_cc-apps.lua, can be found under the install folder. Most of the apps require the library to be installed.

wget https://raw.githubusercontent.com/twh2898/cc-libs/refs/heads/main/install/install_cc-apps.lua

Apps can be used via the cc/ prefix (eg. cc/dig_down or cc/branch_mine).

Development

If you choose to clone this repo, there are a few things you will need to do first. See the ComputerCraft Mod Config section bellow. I

Clone the repo into a computer or turtle directory (cc-libs should be in the root directory). Lua scripts in the project root can be executed on a turtle or computer, or the cc-libs directory can be used in other projects.

git clone git@github.com:twh2898/cc-libs.git # <computer_or_turtle_dir>

lua-ls-cc-tweaked is used to provide type hints / annotations in vscode. Download this repo and place it somewhere in this repo. Add a .gitignore file with the line *.

Test

Testing is performed by the builtin tests/runtest.lua using mock.lua and asserts.lua for support.

make test

Linting & Formatting

Linting is performed by a combination of luacheck and stylua.

• luacheck
• stylua

make lint

Stylua is used for formatting in cli and vs-code.

make format

ComputerCraft Mod Config

This repo is too big for the default computer disk size. In your .minecraft folder, edit the file .minecraft/config/computercraft-server.toml and increase the computer_space_limit line. The default is 10000000.

#The disk space limit for computers and turtles, in bytes.
computer_space_limit = 100000000 # added another 0

Planning

• Need a motion controller independent of rgps
• Motion controller needs to take optional gps or relative gps to track position
• GPS module should be able to operate in place of rgps if a gps signal is available
  • Maybe GPS could have fallback to rgps if signal is lost
• Motion controller needs to have retries of actions up to some limit
• Motion controller should update rgps if in use
• Navigation could take motion controller
  • mocon would have functions for movement
  • navigation would have functions for waypoints and such (no direct motion)

Possible names

• Motion
• MotionController
• MC
• Actions
• TurtleController
• Driver
• Interface
• TurtleInterface

Motion (Controller)

• Includes max retries
• Motion has optional parameter to allow digging