Repository navigation
History and Credits
NebulaScreen is the touchscreen app of NebulaOS. It is based on
GuppyScreen by ballaswag, licensed GPL-3, and stays under
the same licence (see LICENSE and NOTICE in the repository root).
ballaswag/guppyscreen original GuppyScreen
└── probielodan/guppyscreen KE-focused UI rework
└── coreflake1/guppyscreen (OpenKE, earlier "GuppyKE")
└── NebulaOS-guppyscreen → NebulaScreen (renamed October 2026)
Along the way it took fixes and improvements from pellcorp/grumpyscreen and the 3D bed mesh from prestonbrown/guppyscreen. See Contributing for the full credit list.
OpenKE is a separate project with its own SSH installer and releases for stock Creality firmware. It shares history with this repository but is not part of NebulaOS. This wiki used to describe OpenKE's installer, upgrade and uninstall flows; those pages were rewritten for NebulaOS or reduced to short notes. If you want OpenKE, use that repository.
The rename changed every device path and file name (see src/nebulascreen_paths.h). A few internal
names keep the upstream spelling:
- C++ identifiers such as the
GuppyScreenclass (src/guppyscreen.cpp) and theGUPPY_*build flags (GUPPY_SMALL_SCREEN,GUPPY_ROTATE, ...). - The Moonraker database namespace
guppyscreen, which holds macro and console favorites. It is shared by both boot slots and by Mainsail; renaming it would lose the favorites. - The buzzer source
k1/k1_mods/buzzer/guppybeep.c(built asnebulabeep), and the Klipper shell command aliasguppybeepin NebulaOS'sbeeper.cfg. -
GUPPYSCREEN_VERSIONis still accepted by theMakefileas a fallback forNEBULASCREEN_VERSION.
See also: Integration with NebulaOS, Vendored dependencies.
Get started
Get great prints
- Calibration guide (4 steps)
- Calibration walkthrough (A→Z)
- Bed tramming
- Load cell calibration (water bottle)
- Axis Twist Compensation
- Adaptive meshing + purge
- Square parts (Skew Correction)
- Quieter steppers (TMC Autotune)
Using the screen
Help
- Working on NebulaScreen
- Build from source
- Dev & simulator
- Architecture
- Configuration
- Releases & deployment
- Testing
- CI
- Contributing
- Publishing this wiki
NebulaOS