Структура проєкту на Атраменті

Після створення проєкту, як це описано в розділі "Швидкий старт", ви отримуєте таку структуру каталогів:

my-atrament-game/
├─ examples/
├─ resources/
│  ├─ externals/
│  ├─ fonts/
│  ├─ locales/
│  ├─ styles/
│  ├─ themes/
├─ src/
├─ root/
│  ├─ game/
│  ├─ logo.png
├─ atrament.config.json

інформація

Файли і каталоги, які не вказані на діаграмі вище (node_modules, tools, vite і т.д.), є частиною інструментарію для збірки застосунку. Не треба їх видаляти чи редагувати, хіба що ви впевнені, що робите і навіщо.

Файли гри

Файли гри розташовані в каталозі root/game. Головний Ink-скрипт гри - це файл story.ink. Ви можете створити декілька Ink-файлів і використати оператор INCLUDE в файлі story.ink, щоб об'єднати їх в один скрипт.

Медіа-файли (зображення, звуки, музика тощо) мають бути розміщені в цьому каталозі або його підкаталогах. Шлях до них має бути вказаний відносно до каталогу root/game:

Структура каталогів

├─ root/
│  ├─ game/
│  │  ├─ images/
│  │  │  ├─ intro.jpg
│  │  ├─ sounds/
│  │  │  ├─ thunder.mp3
│  │  ├─ story.ink

root/game/story.ink

=== my_story
IMAGE: images/intro.jpg
PLAY_SOUND: sounds/thunder.mp3

Файл logo.png в каталозі root використовується для створення значків для застосунку. Ви можете замінити його.

Ресурси

Каталог resources містить додаткові ресурси для Atrament Web UI: шрифти, переклади, стилі CSS, теми оформлення та зовнішні функції.

Каталог	Опис
externals	Містить файли з визначеннями зовнішніх функції. Дивіться розділ "Зовнішні функції".
fonts	Містить файли шрифтів. Ви можете додати нові шрифти або видалити існуючі. Дивіться розділ "Оформлення".
locales	Містить переклади інтерфейсу Атраменту. Ви можете використовувати ua.json як шаблон для створення власних перекладів.
styles	Містить файл custom.css, куди ви можете додати власні CSS класи, або перевизначити вже існуючі. Дивіться розділ "Оформлення".
themes	Містить теми оформлення застосунку. Дивіться розділ "Оформлення".

Конфігурація

Файл atrament.config.json містить конфігурацію застосунку на Атраменті: назву гри, шрифт та тему оформлення, мову та локаль, назву головного скрипта тощо.

Приклади

Каталог examples містить декілька прикладів Ink скриптів. Ви можете замінити вміст каталогу root/game вмістом каталогу з прикладів, щоб відтворити його в Атраменті.

Код рушія Атрамент

Каталог src містить код рушія Атрамент та веб-застосунку. Зазвичай вам не потрібно його змінювати.