Quickstart (CLI)
- Ensure Python 3.11+ is installed and on PATH.
- Install dependencies:
python -m pip install -r requirements.txt- Edit
files.txtto include the files you want embedded (one per line). - Run the CLI builder:
python build.py --cli --embed-css- To enable Brotli compression for embedded assets:
python -m pip install brotli
python build.py --cli --compress- Ensure Python 3.11+ is installed and on PATH.
- Install dependencies used by the builder:
python -m pip install -r requirements.txt- Edit
files.txtto include the files you want embedded (one per line). - Run the CLI builder:
python build.py --cli --embed-css- To enable Brotli compression for embedded assets:
python -m pip install brotli
python build.py --cli --compressThe web UI provides a drag-and-drop builder and a small HTTP API for builds.
Run the web UI:
python build.pyOpen http://127.0.0.1:5000/everbuilder in your browser.
Notes:
- When started normally the server will attempt to auto-open your default browser. If you want to suppress that behavior, pass
--no-browser.
In order to run the web UI on linux, enter the following into your terminal:
python -m pip install --break-system-packages -r requirements.txt
python build.py --no-browserThen, open your web browser and visit https://127.0.0.1:5000/everbuilder
A Win32 launcher is available in tools/everbuilder_installer/. It provides a GUI with the following features:
- Install Dependencies.
- Launch Web UI.
- Launch Embedded UI
The launcher is a small multi-file C project with a CMakeLists.txt in tools/everbuilder_installer/. Build it with CMake on Windows (MSVC):
cd tools\everbuilder_installer
mkdir build; cd build
cmake ..
cmake --build . --config ReleaseThe built executable will be at tools\everbuilder_installer\build\Release\everbuilder_installer.exe.
The files.txt file tells EverBuilder which files to include when building your offline HTML. It supports file paths and configuration variables.
Place it in the same folder as build.py. List your files and any settings. Example:
# --- Files to Embed ---
index.html
style.css
app.js
assets/logo.png
data/level1.json
# --- Configuration ---
VAR:TITLE=My Cool Game
VAR:PASSWORD=secret123
VAR:FAVICON=assets/icon.png
VAR:DOMAINS=localhost,example.com
VAR:MESSAGE=Welcome to the game!
- Open issues or PRs with improvements.
- Chat on our Discord: https://discord.gg/SsW6agAQxR