cc-libs/README.md

1.1 KiB

Trap's ComputerCraft APIs

Installation

wget run https://raw.githubusercontent.com/guillaumearm/cc-libs/master/install.lua

Install the beta branch:

wget run https://raw.githubusercontent.com/guillaumearm/cc-libs/next/install.lua --beta

APIs

  • /apis/eventloop: a simple event loop API.
  • /apis/net: an API to simplify sending and receiving routed messages, based on the eventloop library.

Servers

All servers are automatically started at boot.

  • /servers/ping-server: allows a machine to respond to a ping command.
  • /servers/cube-server: allows a machine to be controllable via cube.
  • /servers/cube-boot.lua: cube boot script.

Programs

  • router: routes messages. You need to set up a router to use all apis/net-based programs and libraries.
  • ping: pings machines using apis/net.
  • cube: cube client for deployment. Use the cube help command for more details.
  • goo: turtle program for Just Dire Things goo block processing.
  • upgrade: upgrades the machine. Use upgrade --beta to install from the beta branch.

Development

See DEVELOPMENT.md for development setup and workflow.