Skip to main content

Publishing

Atrament project can be published as a single HTML file, a progressive web application, or as a standalone executable for desktop.

Single file

To export a game as a single HTML file (similar to Inky web export or Twine export), run this command in the terminal:

npm run build-singlefile

The resulting web page files will be in the build/singlefile folder.

tip

Single-file build uses only system fonts to reduce output file size. If you want to include all fonts from the resources/fonts folder, use the npm run build-singlefile -- -- --embed-fonts command to build the game.

Web application

To export a game as a progressive web application, run this command in the terminal:

npm run build-web

The resulting web application files will be in the build/web folder.

To preview your application, run this command in the terminal:

npm run preview

The app will be available at http://localhost:4173/.

Desktop executables

info

Atrament uses NeutralinoJS to create executables for desktop OSes.

To build standalone executables for Windows, Linux, and macOS, run this command in the terminal:

npm run build-standalone
warning

On first run, this command downloads NeutralinoJS build toolchain, so an internet connection is required.

Executable files for all platforms will be in the build/standalone folder. The build also creates ZIP archives for each platform.