Skip to content

OpenCreator Installer

The OpenCreator Installer is a touchscreen app that runs on the Creator 5's own screen. It walks you through installing OpenCreator CFW from a USB drive: on the printer itself, or tunneled to a Raspberry Pi / SBC. It backs everything up first, so you can go back. Its source is the opencreator-installer repository.

Download

The installer is part of each OpenCreator release; use the latest one. Extract the zip to the root of a FAT32 USB drive, then follow Steps to install OpenCreator.

What you need

  • A Creator 5 or Creator 5 Pro on FlashForge firmware (1.9.9 recommended)
  • A USB drive that meets the requirements
  • Internet on the printer (Entware, Kalico, Moonraker and the web UIs are downloaded during install)
  • For tunnel mode: an SBC, see OpenCreator for SBC
  • A printer that has at least 200MB on the prog partition and 1gb of storage on the data partition

How it goes

flowchart TD
  A[Check printer model<br/>and kernel package] --> B{Supported?}
  B -->|no| S[Stop: nothing is changed]
  B -->|yes| E{Where should<br/>Klipper run?}
  E -->|On printer SoC| F[Choose Fluidd or Mainsail]
  F --> G[Install GrumpyScreen?]
  E -->|Tunneled| G
  G --> H[Ready to install:<br/>summary]
  H --> I[Back up, then install]
  I --> J[Reboot]
  1. Checking. The installer reads the printer model and FlashForge kernel package. The printer's root filesystem is not changed; everything is installed next to the stock software. The bottom of the screen shows the installer version, the MCU firmware on the drive (and what the boards last got, if OpenCreator flashed them before), the kernel package and the build date.

Installer checking the printer, with the OpenCreator logo 2. Where should Klipper run? On printer SoC installs everything on the printer. Tunneled turns the printer's board into a bridge for an SBC. Both work on every supported FlashForge firmware version. Choosing Tunneled asks for the tunneled-mode password, typed on the screen's keyboard, both for a first install and for switching an installed printer to tunneled. It isn't asked again when the printer is already tunneled.

Where should Klipper run? On printer SoC, Tunneled and Clean up storage 3. Web interface (SoC only): Fluidd (recommended) or Mainsail. Both are installed; the one you pick is the one the printer's web page shows.

Choose web interface: Fluidd (recommended) or Mainsail 4. Touchscreen: install GrumpyScreen (recommended) or not.

Install touchscreen UI? Yes (recommended) or No 5. Ready to install shows the printer, mode, web UI and touchscreen you chose. Back up and install starts; Install without backup skips the backup (faster when re-running); Demo install does a dry run (below).

Ready to install: printer, mode, web UI and touchscreen summary 6. Installing shows each step live with its number (Step 3 of 11), a progress bar and elapsed time. Installing Entware and the Python packages takes a while.

Installing, with the current step, progress bar and elapsed time 7. Installation complete: reboot from the button, then unplug the USB drive.

Installation complete with a Reboot now button

Already installed

If the printer already has OpenCreator from the same installer version, the installer opens on OpenCreator is up to date:

OpenCreator is up to date: Recovery, Update Configs, Update again and Clean up storage

  • Update again re-runs the update with the current setup.
  • Recovery runs the whole setup again, as above.
  • Update Configs asks the same questions (where Klipper runs, web UI, touchscreen), then shows only what differs from the current setup and changes just that. For example, switching from On printer SoC to Tunneled only installs the bridge, and switching back only installs what SoC mode needs and isn't on the printer yet. Switching web UI changes which one the printer serves; turning the touchscreen off keeps GrumpyScreen on the printer but stops starting it. Nothing is backed up. Reboot afterwards.
  • Restore backup and Rollback to stock show up when there's a backup or FlashForge's own firmwareExe to go back to.

Update available

With an older OpenCreator installed, it opens on Update available, which updates in place with the setup shown. Your configs and files are kept; OpenCreator files you changed are saved to the backup. Change setup asks the questions again.

Update available: 0.0.3 to Public Alpha 4, with the setup that's kept

No internet

Without internet, it lists the Wi-Fi networks it can see. Tap one and type its password on the screen's keyboard. Quit starts the printer normally.

No internet connection: a list of Wi-Fi networks with their signal strength

Clean up storage

Every start page (first install, update, already installed, no internet, unsupported kernel) has Clean up storage. Its confirmation page warns that nothing can be brought back, and Yes, delete only works after a 10-second countdown. It deletes:

Clean up storage? The list of what is deleted, the warning, and Yes, delete counting down from 10

  • every print file (.gcode, .3mf, .stl), .mp4 and log under /usr/data and /usr/prog;
  • everything in /usr/data/logs, /usr/data/update (FlashForge update downloads), /usr/data/opencreator/timelapse, /usr/data/opencreator/klipper/logs and the Entware caches;
  • other mods' leftovers (ZMOD, Anvil), old Moonraker copies, and the stock Klipper docs and man pages.

Git checkouts (Klipper, Moonraker, opencreator-fs and the rest), the stock firmware's own model files and the installer's backups are kept. It can't be undone, and OpenCreator takes no responsibility for anything it breaks or removes. Based on CleanFlashforgeCreator5Pro.

Supported kernel packages

Entware needs legacy NaN, which is switched on with one byte written at an address that depends on the FlashForge kernel package (/usr/prog/PROGRAM/kernel/): 0x00a130d1 for 2.0.1 to 2.0.6, 0x00B330D1 for 2.0.7 (FlashForge 1.9.9) and 0x00B030D1 for 2.0.8 (FlashForge 2.0.0). On any other package the installer stops without changing anything.

What gets installed

Step What happens
Entware The Entware package manager in /usr/data/bin/opt, with git, gcc, Python and Moonraker's build dependencies.
LoopScript OpenCreator's startup system from opencreator-fs: it replaces FlashForge's firmwareExe (a copy of the original is kept) and starts everything below at boot. It also replaces the boot logo with the OpenCreator one (the original is backed up).
MCU firmware Flashes all four boards (eBoard, heaterBoard, levelBoard, mainBoardGD) from the package on the USB drive, after checking its checksum. Skipped if the boards already run that firmware.
Klipper Kalico with the OpenCreator printer config, including the first-time setup dialog and the OpenCreator Fluidd theme, in /usr/data/opencreator/klipper. A first install takes the printer's input shaper and hotend and bed PID tuning from FlashForge's config; a config you already have there is kept.
Moonraker The latest Moonraker, replacing FlashForge's older one. Its update manager lists Kalico, Moonraker, Mainsail, Fluidd and opencreator (the OpenCreator configs). Updating opencreator merges the new config templates into yours within a minute, keeping your own edits. Restart Klipper afterwards to load them.
Web UI The latest Mainsail and Fluidd; the printer's web page shows the one you chose.
Touchscreen The latest GrumpyScreen release, if chosen.
Root login Adds the root login opencreator (password FlashForge2026) for SSH. See Root login.
Step What happens
Entware The Entware package manager, with git, gcc and socat.
LoopScript Same as SoC mode; in tunnel mode it starts the bridge instead of Klipper.
MCU firmware Same as SoC mode.
Bridge Installs the socat bridge and switches the printer's board to bridge-only mode, so it forwards the four boards to your SBC over USB.
Touchscreen The latest GrumpyScreen release, if chosen. Point it at your SBC afterwards: set host under [moonraker] in /usr/data/grumpyscreen/grumpyscreen.cfg.
Root login Same as SoC mode.
SBC Not done by the installer: after rebooting the printer, run the SBC installer from OpenCreator for SBC.

Root login

The installer adds a root login, so you can SSH into the printer:

User opencreator
Password FlashForge2026
ssh opencreator@<printer IP>

Change the password

Everyone who installs OpenCreator gets the same default password. To set your own, log in over SSH and run:

passwd opencreator

Type the new password twice. Running the installer again keeps the password you set.

Login banner

Logging in over SSH shows the OpenCreator logo next to some details about the printer, with the model underneath:

        ▄▄▄▄▄▄▄▄      ▄▄▄▄▄▄▄▄▄
    ▗▟████████████▙▞▜███████████▄       OpenCreator
   ▟██▛▘        ▝▜██▙▝       ▝▜███▄     -----------
  ▐██▌            ███▌                  Uptime   2d 13h 22m
  ▐██▌            ███▌                  IP       192.168.2.92 (wlan0)
  ▐██▌            ███▌                  Storage  1.8 GB free of 5.5 GB in /usr/data
  ▐██▙▖           ▜██▙        ▄▄▄▄▖     Host     flashforge
   ▝▜█████████████▄▀████████████▀       Plugins  1 installed (oc-plugin list)
      ▝▀▀▀▀▀▀▀▀▀▀     ▀▀▀▀▀▀▀▀▀
            Creator 5 Pro

root@flashforge:/usr/data/opencreator#

The Plugins line counts the installed plugins; with none it points to oc-plugin search. The prompt is coloured and shows the folder you're in. It works in the printer's own shell, so nothing extra needs installing. If bash is installed through Entware, the login uses bash instead.

  • Only interactive logins get it. SFTP, scp and ssh <printer> <command> aren't affected, so scripts and file transfers work as before.
  • The logo needs a UTF-8 terminal. Windows Terminal, PuTTY and the macOS and Linux terminals all use UTF-8 by default.
  • With bash, your own ~/.bashrc can still set a different prompt.
  • Rolling back to stock removes it. It also turns itself off if FlashForge's firmware is put back any other way, such as a FlashForge update.

To turn it off on your printer, delete /etc/profile.d/opencreator.sh and /usr/data/opencreator/startup/scripts/03-login.sh.

Safety features

  • Model check


    Only a Creator 5 (PID 0028) or Creator 5 Pro (PID 0029) on a supported kernel package is accepted. Otherwise installing is blocked.

  • Backup first


    Before anything changes, FlashForge's firmwareExe, Moonraker, the opencreator folder (Klipper and your config), the web UI folders and the nginx config are archived to the USB drive.

  • Restore


    If a backup exists, the installer offers Restore backup, also right after a failed install. Folders that did not exist before are removed again. MCU firmware is not rolled back, and Entware stays installed.

  • Preflight warnings


    Warns when there is less than 256 MB free on the printer or the USB drive, or the backup folder is missing or read-only.

  • Log


    The Log button shows everything the installer did. The same log is saved to the USB drive as opencreator-installer.log.

  • Demo install


    Runs every step for real, but writes into a separate folder instead of the system, so you can see exactly what would change without touching the printer.

When the install finishes, it records what was installed (installer version, model, mode, web UI, touchscreen, backup location and time) in /usr/data/opencreator/install.json. The next run shows that as the previous install.

Power

Do not power off the printer while the installer is running, especially during MCU flashing. A power loss there can leave the printer needing firmware recovery.