
How the workflow fits together
- Export your compiled firmware into a single image M5Burner can use.
- Publish it under USER CUSTOM with a name, version, description and device type.
- Share it with a Share Code, or make it public in the firmware list.
- Others use Share Burn with your code to flash the same build.
Step 1: Export firmware
M5Stack's tutorial recommends using M5Burner's Firmware Export feature to prepare the file you will publish. You choose the device and an export path, start the export and wait for the progress bar to reach 100%. The exported firmware then appears in the folder you set.
Step 2: Publish
- Open M5Burner and click USER CUSTOM in the bottom-left corner.
- Choose Publish.
- Fill in the details and click Upload.
| Field | What to enter |
|---|---|
| Name | The firmware's name as users will see it |
| Version | Your version number, for example 1.2.0 |
| Description | What it does and how to use it |
| Device Type | The M5Stack device the firmware is built for |
| Github | Link to the project's GitHub page |
| FirmWare | The exported firmware file |
| Cover | An image shown for the firmware in M5Burner |
Step 3: Manage your upload
Uploaded firmware appears in your USER CUSTOM list with these controls:
- Detail: edit the information again.
- Publish: change whether the firmware is public.
- Share: get the firmware's Share Code.
- Remove: delete the firmware from M5Burner.
Step 4: Share Burn
Send the Share Code to a colleague, student or customer. In M5Burner they use the Share Burn function, enter the code and burn the exact build you uploaded, even if it isn't public.
Good publishing practice
- Write clear instructions, including how to get back to official firmware.
- Link the source code so users can check what the firmware does.
- Increase the version number with every upload and describe what changed.
- Only publish firmware you have the right to distribute, and respect the licences of libraries you used.
- Keep private builds private: share codes rather than making internal firmware public.
Versioning tips for teams
Use the same version number in your source code, the export file name and the M5Burner listing, so anyone can match a device to the exact build. Note the device type and any required settings in the description. If a release breaks something, publish a fixed version rather than editing the old upload, so users can still roll back.
Publishing in the web era
WebBurner also lists user-published firmware and supports sharing and reviews. As the desktop app approaches its reported end of service on January 1, 2027, expect publishing to move to the web version. See M5Burner online.
Get M5Burner v3.0
Official package for Windows, macOS and Linux x64, downloaded from M5Stack.


