{"id":17775485,"url":"https://github.com/mjonuschat/mainsailos-extended","last_synced_at":"2025-04-01T16:25:38.337Z","repository":{"id":137067167,"uuid":"536376663","full_name":"mjonuschat/MainsailOS-extended","owner":"mjonuschat","description":"A Raspberry Pi OS based distribution for 3D Printers","archived":false,"fork":false,"pushed_at":"2023-01-09T01:14:02.000Z","size":2340,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-07T10:35:59.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mjonuschat.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}},"created_at":"2022-09-14T01:58:39.000Z","updated_at":"2022-11-06T09:21:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"625110eb-a12c-4e1e-a232-b3270717c273","html_url":"https://github.com/mjonuschat/MainsailOS-extended","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/mjonuschat%2FMainsailOS-extended","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjonuschat%2FMainsailOS-extended/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjonuschat%2FMainsailOS-extended/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjonuschat%2FMainsailOS-extended/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjonuschat","download_url":"https://codeload.github.com/mjonuschat/MainsailOS-extended/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246669388,"owners_count":20814807,"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":[],"created_at":"2024-10-26T21:57:39.813Z","updated_at":"2025-04-01T16:25:38.318Z","avatar_url":"https://github.com/mjonuschat.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/mjonuschat/MainsailOS-extended/pull/73 --\u003e\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n# MainsailOS (extended)\n\n## About The Project\n\nThis project takes the fantastic MainsailOS distribution for 3D Printers and adds the (few) features I desired for a polished out-of-the-box experience, namely a bootsplash that hides the diagnostic Linux boot messages and KlipperScreen to replace the default LCD interface.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Getting Started\n\nThis repository contains a [CustomPiOS](https://github.com/guysoft/CustomPiOS) distribution that takes the latest official MainsailOS image and extends it by adding the following features:\n\n- Boot splash screen\n- KlipperScreen\n- Localization settings\n\n### Customizing the bootsplash screen\n\n#### Choosing the default Voron bootsplash color\n\nAdd (or modify) the following line in your `config.local` file to choose the\ndesired color scheme:\n\n```bash\nexport BOOTSPLASH_IMAGE=\"voron/voron_splash_red.png\"\n```\n\nThis will activate the desired image as the bootsplash screen.\n\n#### Custom image as a splash screen\n\nCopy the desired image into the\n`src/modules/bootsplash/filesystem/root/usr/share/bootscreens/custom` path. Make\nsure it is a **PNG** image with a width of **1024** and a height of **600**\npixels. If your screen has a different aspect ratio it might be OK to deviate. \n\nActivate the custom image by adding the following code to your `config.local` file.\n```bash\nexport BOOTSPLASH_IMAGE=\"custom/my-custom-bootsplash.png\"\n```\n\n### Building the image\n\nThe build process for this image utilizes **Docker** and needs `docker-compose` to run.\nStart the build by running the following command in the root directory of the project:\n\n```bash\n./build\n```\n\nIf the build process succeeded you should find a new compressed MainsailOS image\nin the `src/workspace/` folder with a name similar to\n`MainsailOS-buster-lite-0.7.1-extended.zip`.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- INSTALLING --\u003e\n## How to install MainsailOS-extended\n\nYou can find detailed instructions in the MainsailOS [documentation](https://docs.mainsail.xyz/setup/mainsail-os).\n\nInstallation via [Raspberry Pi Imager](https://docs.mainsail.xyz/setup/mainsailos/pi-imager) [Etcher](https://github.com/balena-io/etcher) is highly recommended.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated** but please check if the contribution would benefit a larger audience and submit it to the Mainsail or MainsailOS repositories if that is the case.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the GPLv3 License. See `LICENSE` for more information.\n\nThe Voron-themed bootsplash images have been created and shared by samwiseg0\nunder the [GPLv3\nLicense](https://github.com/samwiseg0/misc_3dprinting/blob/main/LICENSE) in the\n[samwiseg0/misc_3dprinting](https://github.com/samwiseg0/misc_3dprinting/tree/main/guides/voron_rpi_bootscreen/Images)\nrepository.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- SUPPORT --\u003e\n## Support\n\nIf you're having any problems, please [raise an issue][issues-new] on GitHub, and I will do my best to help.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n\nThis project is standing on the shoulders of giants and without their work, none\nof this would have been possible.\n\n* [Mainsail](https://docs.mainsail.xyz)\n* [KlipperScreen](https://klipperscreen.readthedocs.io/en/latest/)\n* [CustomPiOS](https://github.com/guysoft/CustomPiOS)\n* [Voron Design](https://vorondesign.com)\n* [samwiseg0](https://github.com/samwiseg0/misc_3dprinting/tree/main/guides/voron_rpi_bootscreen/Images)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/mjonuschat/MainsailOS-extended.svg?style=for-the-badge\n[contributors-url]: https://github.com/mjonuschat/MainsailOS-extended/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/mjonuschat/MainsailOS-extended.svg?style=for-the-badge\n[forks-url]: https://github.com/mjonuschat/MainsailOS-extended/network/members\n[stars-shield]: https://img.shields.io/github/stars/mjonuschat/MainsailOS-extended.svg?style=for-the-badge\n[stars-url]: https://github.com/mjonuschat/MainsailOS-extended/stargazers\n[issues-shield]: https://img.shields.io/github/issues/mjonuschat/MainsailOS-extended.svg?style=for-the-badge\n[issues-url]: https://github.com/mjonuschat/MainsailOS-extended/issues\n[issues-new]: https://github.com/mjonuschat/MainsailOS-extended/issues\n[license-shield]: https://img.shields.io/github/license/mjonuschat/MainsailOS-extended.svg?style=for-the-badge\n[license-url]: https://github.com/mjonuschat/MainsailOS-extended/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjonuschat%2Fmainsailos-extended","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjonuschat%2Fmainsailos-extended","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjonuschat%2Fmainsailos-extended/lists"}