PotoFlux is a lightweight JavaFX sandbox application released under the MIT License (LICENSE). The core provides a minimal framework that can be extended through mods. Mods act as launchers for other applications, tools for reviewing, productivity helpers, and more. By adding or removing mods you can customise the environment to suit any workflow.
The architecture is intentionally simple:
- Core – a thin JavaFX base that handles the window, menu bar, and a tab‑based UI.
- Mod API – a well‑documented interface that lets developers register a new tab, add commands to the built‑in terminal, or expose custom settings.
- Easy-to-use – each mod is discovered at startup from the
mods/directory in the user's personal folder and loaded dynamically.
Because the design is straightforward, new contributors can understand the whole system in a few minutes and immediately start building powerful extensions.
- Mod‑driven extensibility – install, enable or disable mods without rebuilding the app.
- Built‑in terminal – interact with mods through simple commands.
- Dynamic UI – each mod can provide its own tab, toolbar entries, or settings page.
- Cross‑platform – runs on any platform that supports JavaFX.
- Get your installer on our website
- Run the installer on your computer
- Launch the app through the
Potofluxicon created on your desktop - Go to the terminal and tap
modDir, or in the menu bar:File > Open mod dir - Drop a mod JAR into the
mods/folder opened and restart the app.
There are no real tutorials on how to make a mod yet.
You can still refer to the template mod repository
and read to Potoflux's docs, available on the website. Please be sure to look for the docs corresponding to your version.
There can be online docs, or you could need to download the jar file and extract it yourself.
If the application crashes, inspect the log files in logs/. The exit codes are:
| Exit code | Meaning | Fix |
|---|---|---|
| 0 | Normal shutdown | |
| 1 | Uncaught error in main thread | Could be anyting. Try relaunching, maybe it appends on a specific action ? |
| 2 | Error during Bootstrap | Try removing mods, clear your user preferences |
| -1 | Event post error | Try removing mods, check compatibility and duped IDs |
When the app crashes, always look for a stack trace. It will help you identify the error !
You can also contact the devs of Potoflux or the mod causing problem.
Join our Discord community for help, discussions, and to share your mods:
- Minheur2000 – original creator of the core application.
- Mkpaz – theme contributions trough AtlantaFX (v2.1.0).