└── README.md /README.md: -------------------------------------------------------------------------------- 1 | # SpruceUI Nightly Repository 2 | 3 | **IMPORTANT UPDATE FOR DEVICES SUPPORTED** 4 | 5 | We are currently focusing on the Flip and A30 support for spruce 4.0 and therefore the trimui device development has hit a pause. 6 | 7 | # Please note: 8 | 9 | **The nightly version does not have an official wiki, the main spruce wiki is specifically for the a30.** 10 | 11 | **There are often small differences such as pico8 needing the 'pico_64' file as well.** 12 | 13 | 🚨 **Warning** 🚨 14 | 15 | This repository is automatically generated as part of our nightly builds. It contains experimental and potentially unstable versions of our software. 16 | 17 | As of May, 2025 these build are targeted towards the Miyoo A30, Miyoo Flip, Trimui Brick and Smart Pro. The same SD card can be used for all of these devices, simply swap the card over and it will work! 18 | 19 | Interested in being a tester? To provide feedback and speak with the development team please join our Discord server by clicking on the image below or using [this link](https://discord.gg/KjR5uMQQt9) 20 | 21 | [![spruce logo](https://github.com/user-attachments/assets/ee3ce8fa-87f2-455a-adf6-c071f7ce4e7a) 22 | ](https://discord.gg/KjR5uMQQt9) 23 | 24 | ## **MIYOO FLIP USERS PLEASE USE [THIS](https://github.com/spruceUI/spruceOS/releases/download/flip0.0/miyoo355_fw.img) FIRMWARE** 25 | 26 | **IMPORTANT UPDATE** Sep. 19 2025: We have updated the suggested Miyoo FW version! It is now the same as that used by CarlOS. This allows you to switch between them without needing to update your FW. 27 | 28 | ### To update FW on the Flip: 29 | - Copy and paste [this .img file](https://github.com/spruceUI/spruceOS/releases/download/flip0.0/miyoo355_fw.img) onto the root of a fat32 card (blank is best!). 30 | - Boot your device, it will show a rocket ship and reboot when it is done. 31 | 32 | **DO NOT TRY TO BURN THE `.img` FILE ONTO YOUR CARD! JUST COPY/PASTE IT** 33 | 34 | **If using your normal card you MUST DELETE the .img file off the card after the update.** 35 | 36 | Stock will show `20250627233124` listed unded "Device Info" in the Settings tab when booted into stock. 37 | 38 | ## ⚠️ Important Notices 39 | 40 | - **Unstable Builds**: This repository contains **work-in-progress** code. Features may be incomplete, change unexpectedly, or break entirely. 41 | - **No Guarantees**: We make **no promises** about stability, functionality, or continued support for anything in this repository. 42 | - **No Support**: Issues related to nightly builds will not receive any attention. For stable releases, refer to our [main repository](https://github.com/spruceUI/spruceOS) or [latest release](https://github.com/spruceUI/spruceOS/releases/latest). 43 | - **Not backwards compatible**: Due to the nature of WIP builds, you will likely need to do a fresh install of the eventual public stable release. Simply using the OTA will likely break things. 44 | ## πŸ§ͺ Experimental Warning 45 | - **Data Loss**: Using this software may result in corrupted data or loss of existing configs. 46 | - **Incompatible Changes**: Backward AND Forward compatibility is not guaranteed between nightly versions. Manual updates are occasionally required. 47 | - **Security Risks**: Nightly builds have not been fully tested for vulnerabilities or exploits. 48 | 49 | ## βš™οΈ Installation 50 | 51 | 1) Read the warnings on this page! 52 | 2) Format a fresh, name brand SD card to FAT32. 53 | 3) Download the .7z from the most recent [release](https://github.com/spruceUI/spruceOSNightlies/releases) on the this repo. 54 | 4) Extract the .7z onto a folder on your computer. Fore best results use the program 7zip found here https://www.7-zip.org/. 55 | 5) Copy and paste ALL files from this folder directly to the root of your fresh SD card. Make sure to get the hidden `.tmp_update` folder! 56 | 6) Boot your device with this SD card inserted into the righthand slot if your using a Flip. 57 | 7) Give it a few minutes and let it do its thing! When the installation is complete, you will land in spruceUI. 58 | 59 | ## 🚑 Updating 60 | 61 | There are a couple of ways to update, OTA, EZ, and manually. 62 | 63 | OTA: Connect to wifi and run the updater app, if your wifi connection holds on this is all you need to do! 64 | 65 | EZ: Download the latest Nightly Release 7z and paste it directly onto the root of your SD card WITHOUT unzipping it. An EZupdater app will show up on your device, click on it and that is all you need to do! 66 | 67 | Manual: 68 | 69 | 1) Delete everything EXCEPT the `Roms` `BIOS` `Saves` `Collections` and `Persistent` folders from your SD card. 70 | 2) Download the .7z from the most recent β€œrelease” on the this repo. 71 | 3) Extract the .7z onto a folder on your computer. 72 | 4) Copy and paste ALL files from this folder directly to the root of your fresh SD card. Make sure to get the hidden `.tmp_update` folder! 73 | 5) Boot your device with this SD card inserted into the righthand slot if your using a Flip. 74 | 6) Give it a few minutes and let it do its thing! When the installation is complete, you will land in spruceUI. 75 | 76 | ## 🀝 Contribution 77 | We appreciate your feedback and bug reports! However, please be aware of the following: 78 | 79 | - Contributions targeting nightly/development builds should expect rapid iteration and potential rework. 80 | - Issues unrelated to nightly builds should be reported in our main repository issue tracker with a clear description telling us it is for the **Development** branch. 81 | - Interested in being a tester? To provide feedback and speak with the development team please join our Discord server [here](https://discord.gg/KjR5uMQQt9) 82 | 83 | 84 | ## πŸ“– Documentation 85 | Documentation will lag behind or be non existant for nightly builds. 86 | 87 | ## 🌟 Why Nightly? 88 | Nightly builds help us: 89 | - Validate new features in real-world scenarios. 90 | - Get early feedback from developers and power users. 91 | - Accelerate the development cycle of our software. 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | --------------------------------------------------------------------------------