Repository navigation
Home
NebulaOS is open firmware for the Creality Ender-3 V3 KE: guided printing on its own touchscreen app, with full Klipper control underneath. This manual describes NebulaOS 1.0.1.
Seven short steps, in order. Each one ends with a link to the next.
- What is NebulaOS - what it replaces, safety, and what you need
- Install NebulaOS - from stock Creality firmware or from OpenKE
- First start - Wi-Fi, the printer's address, Mainsail
- First calibration - one guided run, about 7 minutes
- Set up your slicer - two lines of start and end G-code, do not skip this
- Your first print - load filament, print a test, tune the first layer live
- Keeping NebulaOS updated
Install → Connect → Calibrate → Slice → Print.
- Improve your prints - start from what you see: first layer too high or too low, poor adhesion, an uneven bed, a Z offset that drifts
- Calibration explained - bed tramming, Z offset and bed mesh, load cell, axis twist, PID, input shaper, E-steps, skew, TMC autotune
- Print setup NebulaOS adds - adaptive mesh, purge line, bed soak, firmware retraction
- SSH, SFTP and security - logging in, the root password
- Mainsail and Moonraker - the web interface, slicer upload, apps, home automation
-
Custom macros and integrations - your own macros, Spoolman,
RUN_SHELL_COMMAND -
Files, configuration and backups -
printer.cfg, what an update keeps, how to back up - How NebulaOS works
Supported: the Ender-3 V3 KE only - not the Ender-3 V3, V3 SE or V3 Plus.
- Using NebulaScreen - every tab, button and setting on the printer's screen, in the screen's own order.
- Help and recovery - start from the symptom. Going back to stock, Resetting, Recovery.
NebulaOS is not Creality's software and is not supported by Creality. If a page tells you to do something and you cannot find the button it names, that is a bug in this manual - please report it: github.com/NebulaOS-KE/NebulaOS/issues.
1. Get printing
- 1. What is NebulaOS
- 2. Install NebulaOS
- 3. First start
- 4. First calibration
- 5. Set up your slicer
- 6. Your first print
- 7. Keeping NebulaOS updated
2. Improve your prints
3. Using NebulaScreen
- Overview
- Home and printing
- Macros and Console
- Tune
- Settings → Connections
- Settings → Display
- Settings → Printer
- Settings → System
- Settings → Updates
- Settings → Reset
- Camera
- Timelapse
- Power-loss recovery
4. Advanced and integrations
- SSH, SFTP and security
- Files, configuration and backups
- Mainsail and Moonraker
- Custom macros and integrations
- Beeps and songs
- How NebulaOS works
- Two system slots
- Words you will see
5. Help and recovery
- Troubleshooting
- Report a problem
- Going back to stock
- Resetting
- Mainboard firmware
- Recovery (when it will not start)
Developer documentation lives in each component repository. Start from the project README.