thox, a multi-tasking OS for ComputerCraft

thox is an operating system for ComputerCraft providing pre-emptive multitasking, secure thread sandboxing and modern IPC facilities.

The source repository is available on my forge.

The documentation is organized as suggested by Daniele Procida in his conference “What nobody tells you about documentation” (watch), which was filmed at PyCon Australia 2017; watching this conference is recommended for contributing to this wiki. It uses a specific vocabulary; see Glossary.

Any question? Any issue? Any security flaw, such as a sandbox escape? You can either contact me by mail at thomas@touhey.fr or on the Computer Mods Discord Server (@cake).

Warning

This project is in early alpha and documentation-driven, which means the documentation will very probably be in advance on the code. This is because I strongly believe that while the code might disappear, what will stay is the concepts and the user experience attempted at in this project, and the notions covered in the documentation (including protocols’ and file formats descriptions).

• Onboarding
  • Running thox
• Howtos
  • How to set up a GPS cluster with thox?
  • How to transfer a file between two devices?
  • How to program a daemon?
• Environment
  • Computers
  • Character encodings
    • ComputerCraft encoding
    • OpenComputers encoding
  • Buses and components
    • Core bus
    • ComputerCraft side bus
    • ComputerCraft wired bus
    • OpenComputers bus
  • Video devices
  • Modem networking
    • ComputerCraft modems
    • OpenComputers modems
    • Skynet modems
    • rednoot modems
  • Modem protocols
    • Rednet
      • Rednet lookup protocol
      • Rednet TRoR protocol
    • Rednet derivatives
    • Port protocols
      • GPS protocol
      • OneOS protocols
      • OPUS OS protocols
      • LDDestroier’s protocols
      • JackMac’s protocols
      • gollark’s modem protocols
• Core system design
  • thox startup
    • startup components
    • startup implementations
      • ComputerCraft and derivatives
      • OpenComputers and derivatives
    • thox startup API
      • Startup standard APIs
      • Startup components API
  • thox processes and interactions
    • thox concepts: contexts and interactions
      • Events
      • Remote Procedure Call (RPC)
    • thox native process runtime API
      • Process related calls
      • Context related calls
      • Events
      • Asynchronous RPC
      • Synchronous RPC
      • Other functions
    • APIs of contexts managed by the process manager
    • thox process manager
      • How this is accomplished in Lua
      • System calls and coroutines
      • Startup and main loop
    • thox process manager API
      • General constants
      • Process Manager
  • initd: the thox init daemon
    • initd RPC bindings
  • fsd: the thox filesystem daemon
    • fsd RPC bindings
      • File descriptor calls
  • gpsd: the thox GPS daemon
    • gpsd RPC bindings
  • netd: the thox network daemon
    • netd RPC bindings
  • rand: the thox random and entropy production daemon
    • rand RPC calls
  • pkgd: the thox package management daemon
    • pkgbuild format
• Core libraries
  • daemon: daemon programming made accessible
  • iconv: character encoding conversions
  • magick: manipulate pictures easier
• Notable people
• Glossary