atrament-preact-ui is an example application for playing Ink games, built with inkjs, Atrament, and Preact.
git clone https://github.com/technix/atrament-preact-ui.git
cd atrament-preact-ui
npm install
npm start
The application is available at http://localhost:8900
To build the application bundle for publishing, use npm run build command. Application will be in build folder.
| Tag | Description |
|---|---|
# title: A Story Written In Ink |
Game title |
# author: John Doe |
Author |
# theme: light |
Game color theme: light, sepia, or dark |
# font: System |
Game font: System, Fira Sans, Lora, Merriweather, or OpenDyslexic |
# observe: varName |
Register variable observer for varName Ink variable. Variable value is available in vars section of Atrament state. |
# autosave: false |
Disables autosaves. |
# single_scene |
Store only last scene in Atrament state. |
| Tag | Description |
|---|---|
# IMAGE: some/picture.jpg |
Show image before paragraph text. |
# CLEAR |
Clear scenes list before saving current scene to Atrament state. |
# AUDIOLOOP: music.mp3 # MUSIC: music.mp3 |
Play music (looped). |
# AUDIOLOOP: false # MUSIC: false |
Stop playing music. |
# AUDIO: sound.mp3 # SOUND: sound.mp3 |
Play sound (once). |
# CHECKPOINT |
Save game to 'default' checkpoint. |
# CHECKPOINT: checkpointName |
Save game to checkpoint checkpointName. |
# SAVEGAME: saveslot |
Save game to saveslot. |
# RESTART |
Start game from beginning. |
# RESTART_FROM_CHECKPOINT |
Restart game from latest checkpoint. |
# RESTART_FROM_CHECKPOINT: checkpointName |
Restart game from named checkpoint. |
See Atrament core documentation.
Atrament is distributed under MIT license.
Copyright (c) 2023 Serhii "techniX" Mozhaiskyi