{"id":22007967,"url":"https://github.com/thecurle/chroma","last_synced_at":"2025-05-05T23:23:44.401Z","repository":{"id":44363882,"uuid":"277384164","full_name":"TheCurle/Chroma","owner":"TheCurle","description":"The Chromatic OS","archived":false,"fork":false,"pushed_at":"2023-06-24T21:13:17.000Z","size":10466,"stargazers_count":19,"open_issues_count":4,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T00:41:18.535Z","etag":null,"topics":["amd64","hobby-os","kernel","x86","x86-64"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheCurle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"TheCurle","ko-fi":"curle"}},"created_at":"2020-07-05T21:12:38.000Z","updated_at":"2023-12-07T05:27:58.000Z","dependencies_parsed_at":"2024-11-30T01:30:44.089Z","dependency_job_id":"c61307f3-824f-4af1-bf37-ad6d3b7c2980","html_url":"https://github.com/TheCurle/Chroma","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheCurle%2FChroma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheCurle%2FChroma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheCurle%2FChroma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheCurle%2FChroma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheCurle","download_url":"https://codeload.github.com/TheCurle/Chroma/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252591378,"owners_count":21773080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amd64","hobby-os","kernel","x86","x86-64"],"created_at":"2024-11-30T01:30:38.179Z","updated_at":"2025-05-05T23:23:44.384Z","avatar_url":"https://github.com/TheCurle.png","language":"C++","funding_links":["https://github.com/sponsors/TheCurle","curle"],"categories":[],"sub_categories":[],"readme":"![Chroma Logo](https://gemwire.uk/img/chroma/logo/480p.png)\n\n# Chroma\nThe Chromatic OS\n\n## About\nChroma is an x86_64 kernel, soon to be Operating System.  \nIt uses the [bootboot](https://gitlab.com/bztsrc/bootboot) bootloader.\n\n## Features\nIt can currently: \n - [x] read keyboard input\n - [x] draw to the screen, including text and basic images.\n - [x] output audio over the PC Speaker\n - [x] manage physical memory\n - [x] manage virtual memory\n - [ ] switch to ring 3\n - [ ] switch tasks\n - [ ] schedule tasks\n - [ ] handle processes and threads\n - [ ] handle mouse input\n - [ ] display a basic 3D object\n - [ ] display a basic 3D world\n - [ ] display a basic 3D world *in VR*\n\nOnce we reach this point... well, the world is our oyster.\n\n## Building\n\nChroma can be built on Windows or Linux.\n\n### Windows\nI (Curle) use Windows for developing Chroma.  \nSimply have an [x86_64-elf-gcc](https://github.com/lordmilko/i686-elf-tools) and ld (included!) in your PATH, run `cmake` in the source directory, then `make`.\nIt will compile the kernel, and create an OS image with `mkbootimg`.\n\n\n### Linux\n\nThe system for linux is a lot easier, but you *do* need an x86_64-elf-gcc cross compiler. You can get one from the AUR on Arch-based distros (like Manjaro), or make one yourself using [the OSDev Wiki guide](https://wiki.osdev.org/GCC_Cross-Compiler)  \n\nOn the Chroma side, Simply run the `init.sh` to generate a makefile, then `make` to create the image file.  \n\n\nThe generated IMG works in QEMU, or on a physical test device (unlike a lot of other hobby OSes!)\nThis means you can use any emulator or hypervisor to run it.\n\n \n## Project structure\n\nThe repository has a lot of files and folders after setting up a workspace. This is a guide to all the files and folders.\n\n```\n\n      File Location                          | Description\n/\n├── bin/                                     |  Binary Output folder\n│   └── img/                                 |  Image Output folder.\n│       └── chroma.img                       |  Disk Image file, as an alternative to ISO below.\n│                                            |                       \n├── inc/                                     |  Global header include folder.\n│   ├── driver/                              |  Header files for the default driver implementations.\n│   ├── editor/                              |  Header files for the builtin editor and debugger.\n│   ├── kernel/                              |  Header files for the Chroma kernel itself.\n│   └── lainlib/                             |  Header files for the Lainlib standard library.\n│                                            | \n├── src/                                     |  Source files.\n│   ├── assets/                              |  Assorted linkable files that will be bundled with the built image.\n│   ├── drivers/                             |  Handling of the default driver implementations.\n│   ├── editor/                              |  Handling of the builtin editor and debugger.\n│   ├── global/                              |  Various files used in global objects (ie. the C RunTime, new core bootstrapping, etc)\n│   ├── lainlib/                             |  Handling of the Lainlib standard library.\n│   ├── system/                              |  Core Kernel files.\n│   ├── video/                               |  Writing and drawing on the screen.\n│   └── kernel.cpp                           |  The primary kernel entry point.\n│                                            | \n├── tools/                                   |  Auxiliary tools used in the buildsystem.\n│   └── mkbootimg/                           |  Creates a bootable .img file based on the chroma.json configuration file below.\n│                                            | \n├── .gitignore                               |  Git Repository Ignored Files\n├── build_and_run.sh                         |  shell script that builds the img file and runs it using run.sh below.\n├── choma.bxrc                               |  bxrc (Bochs Runtime Config) file for the Bochs emulator and debugger.\n├── chroma.iso                               |  ISO disc image file that can be loaded into a VM or onto a boot disk.\n├── chroma.json                              |  MkBootImg configuration file\n├── CMakeLists.txt                           |  Buildscript and CMake project configuration file.\n├── LICENSE                                  |  Chroma's License. MIT License.\n├── linker.ld                                |  GCC linkerscript that places files and addresses at their expected positions.\n├── post.sh                                  |  Postprocessing script; Generates the final img file, and attempts to update a VirtualBox configuration named \"Chroma\" to run this new file instead.\n├── pre.sh                                   |  First-time setup script; generates the font file binary and generates the CMake buildscripts.\n├── README.md                                |  This file.\n└── run.bat                                  |  Attempts to start a Virtualbox VM named \"chroma\".\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecurle%2Fchroma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecurle%2Fchroma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecurle%2Fchroma/lists"}