CC: Tweaked

CC: Tweaked is a fork of ComputerCraft, adding programmable computers, turtles and more to Minecraft.

This website contains documentation for all Lua libraries and APIs from the latest version of CC: Tweaked. This documentation is still in development, so will most likely be incomplete. If you've found something you think is wrong, or would like to help out please get in touch on GitHub.

Globals

_G	Global functions defined by `bios.lua`.
colors	The Colors API allows you to manipulate sets of colors.
colours	Colours for lovers of British spelling.
commands
disk	The Disk API allows you to interact with disk drives.
fs	The FS API allows you to manipulate files and the filesystem.
gps	The GPS API provides a method for turtles and computers to retrieve their own locations.
help	Provides an API to read help files.
http	The http library allows communicating with web servers, sending and receiving data from them.
io	Emulates Lua's standard io library.
keys	The Keys API provides a table of numerical codes corresponding to keyboard keys, suitable for decoding key events.
multishell	Multishell allows multiple programs to be run at the same time.
os	The os API allows interacting with the current computer.
paintutils	An API for advanced systems which can draw pixels and lines, load and draw image files.
parallel	Provides a simple implementation of multitasking.
peripheral	The Peripheral API is for interacting with peripherals connected to the computer, such as the Disk Drive, the Advanced Monitor and Monitor.
pocket	Control the current pocket computer, adding or removing upgrades.
rednet	The Rednet API allows systems to communicate between each other without using redstone.
redstone	Interact with redstone attached to this computer.
settings	The settings API allows to store values and save them to a file for persistent configurations for CraftOS and your programs.
shell	The shell API provides access to CraftOS's command line interface.
term	The Terminal API provides functions for writing text to the terminal and monitors, and drawing ASCII graphics.
textutils	The textutils API provides helpful utilities for formatting and manipulating strings.
turtle	The turtle API allows you to control your turtle.
vector	The vector API provides methods to create and manipulate vectors.
window	The Window API allows easy definition of spaces within the display that can be written/drawn to, then later redrawn/repositioned/etc as need be.

Modules

cc.completion	A collection of helper methods for working with input completion, such as that require by read.
cc.expect	The cc.expect library provides helper functions for verifying that function arguments are well-formed and of the correct type.
cc.image.nft	Provides utilities for working with "nft" images.
cc.pretty	Provides a "pretty printer", for rendering data structures in an aesthetically pleasing manner.
cc.require	This provides a pure Lua implementation of the builtin require function and package library.
cc.shell.completion	A collection of helper methods for working with shell completion.

Peripherals

command	This peripheral allows you to interact with command blocks.
computer	A computer or turtle wrapped as a peripheral.
drive	Disk drives are a peripheral which allow you to read and write to floppy disks and other "mountable media" (such as computers or turtles).
modem	The modem peripheral allows you to send messages between computers.
monitor	Monitors are a block which act as a terminal, displaying information on one side.
printer	The printer peripheral allows pages and books to be printed.
speaker	Speakers allow playing notes and other sounds.