Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/PrinceOfCookies/CookieOS/llms.txt

Use this file to discover all available pages before exploring further.

Installing CookieOS is a single-command process. The installer is a bundled copy of the gitget GitHub downloader utility (originally developed by apemanzilla), pre-configured to pull the entire PrinceOfCookies/CookieOS repository from the main branch directly into the root of your computer’s filesystem. All you need is a CC:Tweaked computer with HTTP access and a copy of the installer file obtained from the project’s GitHub releases.
1

Prerequisites

Before running the installer, confirm the following:
  • CC:Tweaked mod is installed in your Minecraft instance. CookieOS is written entirely in Lua and targets the CC:Tweaked API — it will not run on the original ComputerCraft mod.
  • HTTP is enabled in the CC:Tweaked configuration. The installer fetches files from api.github.com and raw.github.com. If HTTP is disabled, the download will fail immediately.
  • Advanced Computer recommended. CookieOS uses term.isColor() throughout its UI. While it may run on a standard computer, the coloured menus, yellow version watermark, and blue loading bar all require an Advanced Computer (or Advanced Pocket Computer) to display correctly.
2

Open the computer's terminal

Place and right-click an Advanced Computer in your Minecraft world to open its terminal. If you already have a computer with the installer file on it, right-click to open it directly. You should see the standard CC:Tweaked shell prompt (>).
3

Run the install command

The installer file (os/.install) is a self-contained Lua script. Run it from the shell prompt:
.install
Internally, the installer is configured with the following preset values — no arguments are required:
-- The installer downloads all files from GitHub
-- user = "PrinceOfCookies", repo = "CookieOS", branch = "main", path = "/"
The installer first downloads a JSON parsing library from Pastebin (required to decode the GitHub API response), then queries the GitHub Trees API to enumerate every file in the repository, and finally fires asynchronous HTTP requests for all files in parallel. A progress bar is drawn in the terminal as files arrive:
[========          ] 47%
Failed requests are automatically retried after a three-second delay, so a flaky connection should not abort the installation.
4

Wait for the download to complete

The progress bar fills from left to right as each file is saved to disk. When it reaches 100% and the Done message is printed, all CookieOS files have been written to your computer’s filesystem. The total number of files and download time depend on your server’s HTTP throughput settings.
5

The computer reboots automatically into CookieOS

Once the download completes, the computer will reboot. On the next startup, ComputerCraft executes the startup/ folder, which begins the CookieOS boot sequence. You will see the yellow CookieOS v2.2.5 version watermark, followed by an animated loading bar, and then the Start Menu.As part of the first boot, startup/loading.lua automatically removes the installer artefacts that are no longer needed:
File / DirectoryReason removed
jsonTemporary JSON API downloaded by the installer
.installThe installer script itself
README.mdRepository readme, not needed at runtime
.gitignoreGit metadata, not needed at runtime
.vscodeEditor settings directory, not needed at runtime
Modifying files inside the os/, apis/, or startup/ directories may break the operating system in ways that are difficult to diagnose. CookieOS does not sandbox or validate changes to its own system files — if a core file is corrupted or deleted, the OS may fail to boot entirely and require a fresh reinstall. Proceed with caution and keep a backup if you intend to experiment.

​
Uninstalling

To remove CookieOS completely, open the Start Menu, navigate to Uninstall, and press Enter. The uninstaller (os/.uninstall) calls cosUtils.del() on each CookieOS-owned path in sequence, printing progress to the screen as it works: 
del("os", true)
del("apis", true)
del("programReplacements", true)
del("startup", true)
del(".menu", false)
del(".settings", false)
del("back.lua", false)
After all directories and files are removed, the computer waits 1.5 seconds and then reboots. On the next startup, the standard CC:Tweaked shell will load as normal, since the startup/ directory no longer exists.
The uninstaller automatically moves os/.install back to the root (/) before deleting the os/ directory, so the installer is preserved and CookieOS can be reinstalled easily without fetching a new copy.

Build docs developers (and LLMs) love

Get started for freeTalk to us