{"id":15549246,"url":"https://github.com/pineappleionic/borealisos","last_synced_at":"2025-06-14T19:35:26.895Z","repository":{"id":41437694,"uuid":"477702240","full_name":"PineappleIOnic/borealisOS","owner":"PineappleIOnic","description":"A SteamOS 3.0 plugin and customisation framework built using NodeJS.","archived":false,"fork":false,"pushed_at":"2022-07-30T09:30:44.000Z","size":284,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T06:47:13.331Z","etag":null,"topics":["modification","nodejs","plugin","react","steam","steamdeck","steamos"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PineappleIOnic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-04T12:59:34.000Z","updated_at":"2024-09-09T12:20:33.000Z","dependencies_parsed_at":"2022-09-01T23:11:45.935Z","dependency_job_id":null,"html_url":"https://github.com/PineappleIOnic/borealisOS","commit_stats":null,"previous_names":["pineappleionic/borealisos"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/PineappleIOnic/borealisOS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PineappleIOnic%2FborealisOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PineappleIOnic%2FborealisOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PineappleIOnic%2FborealisOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PineappleIOnic%2FborealisOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PineappleIOnic","download_url":"https://codeload.github.com/PineappleIOnic/borealisOS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PineappleIOnic%2FborealisOS/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259870954,"owners_count":22924592,"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":["modification","nodejs","plugin","react","steam","steamdeck","steamos"],"created_at":"2024-10-02T13:32:49.458Z","updated_at":"2025-06-14T19:35:26.854Z","avatar_url":"https://github.com/PineappleIOnic.png","language":"CSS","readme":"\u003cp align=\"center\"\u003e\n\u003cimg width=\"75px\" src=\"./assets/lambda.png\" align=\"center\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eBorealisOS\u003c/h1\u003e\n\u003cp align=\"center\"\u003eA SteamOS 3.0 plugin and customisation framework built using NodeJS.\u003c/p\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\n\u003ch2\u003eDISCLAIMER (READ ME!)\u003c/h22\u003e\n\u003c/summary\u003e\n\n```\nBorealisOS is a plugin manager that gives (currently) unrestricted access to SteamOS's JavaScript instance. \n\nValve binds all SteamOS system functions to this JavaScript instance. Treat installing BorealisOS plugins like installing \napps that require administrator rights because they quite literally can perform administrator actions without you even \nknowing.\n\nMake sure you review all plugins you install and DO NOT install any plugins you do not inherently trust. Anything with\nobfuscation or not very readable code is a big red flag. It would take not even 20 lines of JavaScript to steal your\naccount token and factory reset the device.\n\nWe are not responsible for any device damage caused by using BorealisOS.\n```\n\n\u003c/details\u003e\n\n\u003ch2\u003eInstallation\u003c/h2\u003e\nBorealisOS is currently under heavy development and is not suggested for general use.\n\n__BorealisOS requires CEF Debugging to be enabled within the Developer settings__\n\nIf you still want to install BorealisOS, you can do so by running the following command:\n\n```sh\ncurl -s -L https://github.com/borealisOS/borealisOS/raw/main/install.sh | sudo sh\n```\n\nThis installer installs a service for borealisOS which will make it autolaunch on start up, you can disable this by running the following command:\n\n```sh\nsudo systemctl disable borealis\n```\n\nYou can also uninstall borealisOS by running the following command:\n\n```sh\ncurl -s -L https://github.com/borealisOS/borealisOS/raw/main/uninstall.sh | sudo sh\n```\n\n\nThis installer and uninstaller only supports the Steam Deck, for other platforms clone the repo and run `npm install` followed by `node src/index.js`.\n## Developing\nWe recommend having [VSCode's Remote Explorer extension](https://code.visualstudio.com/docs/remote/ssh) for developing BorealisOS on SteamDeck hardware.\n\nYou can also develop on the PUBLIC-PAL build of Steam if you like to keep everything local or don't have a SteamDeck to develop on.\n\n\u003cp align=\"center\"\u003e\n\u003cimg height=\"500px\" src=\"./assets/settingsPage.jpg\" align=\"center\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n## Credits\nBorealisOS would not be possible without the following people:\n\n- [marios8534](https://github.com/marios8543) For creating the initial steamOS UI Inject. This opened my eyes to what was possible using CEF's debugging API and SteamOS.\n\n- [The SteamDeckHomebrew team](https://github.com/SteamDeckHomebrew) For continuing the work from marios8534's initial UI Inject.\n\n- [Jake 'sid' Smith](https://github.com/JakeSidSmith) For his excellent article on monkey patching React.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpineappleionic%2Fborealisos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpineappleionic%2Fborealisos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpineappleionic%2Fborealisos/lists"}