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.

CookieOS transforms your CC:Tweaked computer into a fully featured mini-OS with a graphical start menu, real-time clock, built-in programs, and a rich Lua utility library (cosUtils). Whether you want a polished desktop experience in-game or a foundation for your own CC:Tweaked projects, CookieOS gives you the tools to build it.

Installation

Install CookieOS on your CC:Tweaked computer in a few quick steps.

Quickstart

Get up and running with the start menu and your first program launch.

Built-in Programs

Explore the File Explorer, Music Player, Chat, and Player Tracker programs.

cosUtils API

Browse the full cosUtils library — UI helpers, crypto, filesystem, and more.

​
What’s inside

CookieOS ships with everything you need for a richer CC:Tweaked experience:

Start Menu

A keyboard-navigable graphical menu with a live clock shown on every screen.

File Explorer

Two-panel file browser with metadata, timestamps, and inline editing.

Music Player

Search and stream DFPWM audio to a CC:Tweaked speaker peripheral.

Chat + AI

In-game chat relay with Gemini AI integration via the ., trigger.

Player Tracker

Display live player coordinates on an attached monitor peripheral.

Program Replacements

Enhanced list, ls, shell, screenfetch, and more replacing CC defaults.

​
Getting started

1

Install CookieOS

Run the installer on your CC:Tweaked computer. It downloads all files directly from GitHub and reboots into the new OS.
-- Paste this into the CC:Tweaked shell
pastebin run <install-pastebin-code>
See the Installation guide for the full command.
2

Navigate the Start Menu

Use the Up/Down arrow keys to select an option, then press Enter. The menu offers Command, Programs, Power, Uninstall, and Help.
3

Launch a program

Choose Programs from the start menu to open the program launcher. Select File Explorer, Play Music, Chat, or Player Tracker.
4

Use cosUtils in your own scripts

cosUtils is globally available after boot. Call any function directly:
cosUtils.logToOS("Hello from my script")
local t = cosUtils.getTime("12")
print(t) -- e.g. "2024-01-15 03:45:22 PM"
CookieOS requires a CC:Tweaked computer (Advanced Computer recommended for full colour support). HTTP must be enabled in the CC:Tweaked config for the installer and Music Player to work.

Build docs developers (and LLMs) love

Get started for freeTalk to us