From d5d803fa601a4c1c77d2c515b03d4f59c1fab118 Mon Sep 17 00:00:00 2001 From: Guillaume ARM Date: Sun, 31 May 2026 03:08:31 +0200 Subject: [PATCH] docs: add cc tweaked glossary --- CLAUDE.md | 2 + docs/cc_glossary.md | 119 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 121 insertions(+) create mode 100644 docs/cc_glossary.md diff --git a/CLAUDE.md b/CLAUDE.md index df2fbf0..bacac55 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,6 +6,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co A collection of [ComputerCraft](https://tweaked.cc/) (CC:Tweaked) Lua APIs, servers, and programs for in-game networked computers. Targets **CC:Tweaked for Minecraft 1.21** (latest). Runtime is the ComputerCraft Lua sandbox (`fs`, `peripheral`, `os.pullEvent`, `shell`, `parallel`, `modem.transmit`, etc.), not standard Lua. +When more CC:Tweaked API details are needed, is a useful documentation entrypoint. It is not mandatory to fetch every time, but its left-hand navigation includes the broader glossary and links to globals, modules (for example `cc.base64` and `cc.pretty`), peripherals, and events, even when the topic is not turtle-specific. A compact local index of these documentation pages is maintained in `docs/cc_glossary.md`. + ## Tooling constraints - **There is no way to run, build, or test this code yet.** It only executes inside ComputerCraft (in-game or under CraftOS-PC). Do not attempt to run Lua locally or add a test harness unless asked. diff --git a/docs/cc_glossary.md b/docs/cc_glossary.md new file mode 100644 index 0000000..890e7a6 --- /dev/null +++ b/docs/cc_glossary.md @@ -0,0 +1,119 @@ +# CC:Tweaked Documentation Glossary + +Compact index of CC:Tweaked documentation pages from . The turtle page, , is a useful entrypoint because the left-hand navigation exposes this full glossary. + +Last checked: 2026-05-31. + +## Globals + +- [_G](https://tweaked.cc/module/_G.html) +- [colors](https://tweaked.cc/module/colors.html) +- [colours](https://tweaked.cc/module/colours.html) +- [commands](https://tweaked.cc/module/commands.html) +- [disk](https://tweaked.cc/module/disk.html) +- [fs](https://tweaked.cc/module/fs.html) +- [gps](https://tweaked.cc/module/gps.html) +- [help](https://tweaked.cc/module/help.html) +- [http](https://tweaked.cc/module/http.html) +- [io](https://tweaked.cc/module/io.html) +- [keys](https://tweaked.cc/module/keys.html) +- [multishell](https://tweaked.cc/module/multishell.html) +- [os](https://tweaked.cc/module/os.html) +- [paintutils](https://tweaked.cc/module/paintutils.html) +- [parallel](https://tweaked.cc/module/parallel.html) +- [peripheral](https://tweaked.cc/module/peripheral.html) +- [pocket](https://tweaked.cc/module/pocket.html) +- [rednet](https://tweaked.cc/module/rednet.html) +- [redstone](https://tweaked.cc/module/redstone.html) +- [settings](https://tweaked.cc/module/settings.html) +- [shell](https://tweaked.cc/module/shell.html) +- [term](https://tweaked.cc/module/term.html) +- [textutils](https://tweaked.cc/module/textutils.html) +- [turtle](https://tweaked.cc/module/turtle.html) +- [vector](https://tweaked.cc/module/vector.html) +- [window](https://tweaked.cc/module/window.html) + +## Modules + +- [cc.audio.dfpwm](https://tweaked.cc/library/cc.audio.dfpwm.html) +- [cc.base64](https://tweaked.cc/library/cc.base64.html) +- [cc.completion](https://tweaked.cc/library/cc.completion.html) +- [cc.expect](https://tweaked.cc/library/cc.expect.html) +- [cc.image.nft](https://tweaked.cc/library/cc.image.nft.html) +- [cc.pretty](https://tweaked.cc/library/cc.pretty.html) +- [cc.require](https://tweaked.cc/library/cc.require.html) +- [cc.shell.completion](https://tweaked.cc/library/cc.shell.completion.html) +- [cc.strings](https://tweaked.cc/library/cc.strings.html) + +## Peripherals + +- [command](https://tweaked.cc/peripheral/command.html) +- [computer](https://tweaked.cc/peripheral/computer.html) +- [drive](https://tweaked.cc/peripheral/drive.html) +- [modem](https://tweaked.cc/peripheral/modem.html) +- [monitor](https://tweaked.cc/peripheral/monitor.html) +- [printer](https://tweaked.cc/peripheral/printer.html) +- [redstone_relay](https://tweaked.cc/peripheral/redstone_relay.html) +- [speaker](https://tweaked.cc/peripheral/speaker.html) + +## Generic Peripherals + +- [energy_storage](https://tweaked.cc/generic_peripheral/energy_storage.html) +- [fluid_storage](https://tweaked.cc/generic_peripheral/fluid_storage.html) +- [inventory](https://tweaked.cc/generic_peripheral/inventory.html) + +## Events + +- [alarm](https://tweaked.cc/event/alarm.html) +- [char](https://tweaked.cc/event/char.html) +- [computer_command](https://tweaked.cc/event/computer_command.html) +- [disk](https://tweaked.cc/event/disk.html) +- [disk_eject](https://tweaked.cc/event/disk_eject.html) +- [file_transfer](https://tweaked.cc/event/file_transfer.html) +- [http_check](https://tweaked.cc/event/http_check.html) +- [http_failure](https://tweaked.cc/event/http_failure.html) +- [http_success](https://tweaked.cc/event/http_success.html) +- [key](https://tweaked.cc/event/key.html) +- [key_up](https://tweaked.cc/event/key_up.html) +- [modem_message](https://tweaked.cc/event/modem_message.html) +- [monitor_resize](https://tweaked.cc/event/monitor_resize.html) +- [monitor_touch](https://tweaked.cc/event/monitor_touch.html) +- [mouse_click](https://tweaked.cc/event/mouse_click.html) +- [mouse_drag](https://tweaked.cc/event/mouse_drag.html) +- [mouse_scroll](https://tweaked.cc/event/mouse_scroll.html) +- [mouse_up](https://tweaked.cc/event/mouse_up.html) +- [paste](https://tweaked.cc/event/paste.html) +- [peripheral](https://tweaked.cc/event/peripheral.html) +- [peripheral_detach](https://tweaked.cc/event/peripheral_detach.html) +- [rednet_message](https://tweaked.cc/event/rednet_message.html) +- [redstone](https://tweaked.cc/event/redstone.html) +- [setting_changed](https://tweaked.cc/event/setting_changed.html) +- [speaker_audio_empty](https://tweaked.cc/event/speaker_audio_empty.html) +- [task_complete](https://tweaked.cc/event/task_complete.html) +- [term_resize](https://tweaked.cc/event/term_resize.html) +- [terminate](https://tweaked.cc/event/terminate.html) +- [timer](https://tweaked.cc/event/timer.html) +- [turtle_inventory](https://tweaked.cc/event/turtle_inventory.html) +- [websocket_closed](https://tweaked.cc/event/websocket_closed.html) +- [websocket_failure](https://tweaked.cc/event/websocket_failure.html) +- [websocket_message](https://tweaked.cc/event/websocket_message.html) +- [websocket_success](https://tweaked.cc/event/websocket_success.html) + +## Guides + +- [Setting up GPS](https://tweaked.cc/guide/gps_setup.html) +- [Allowing access to local IPs](https://tweaked.cc/guide/local_ips.html) +- [Playing audio with speakers](https://tweaked.cc/guide/speaker_audio.html) +- [Running programs on computer startup](https://tweaked.cc/guide/startup.html) +- [Reusing code with require](https://tweaked.cc/guide/using_require.html) + +## Reference + +- [Block details](https://tweaked.cc/reference/block_details.html) +- [Incompatibilities between versions](https://tweaked.cc/reference/breaking_changes.html) +- [The /computercraft command](https://tweaked.cc/reference/computercraft_command.html) +- [Entity details](https://tweaked.cc/reference/entity_details.html) +- [CraftOS's exception protocol](https://tweaked.cc/reference/exceptions.html) +- [Lua 5.2/5.3 features in CC: Tweaked](https://tweaked.cc/reference/feature_compat.html) +- [Item details](https://tweaked.cc/reference/item_details.html) +- [Computer startup](https://tweaked.cc/reference/startup.html)