Перейти до основного вмісту

Що таке Атрамент

Атрамент - це модульний інструмент для створення текстових ігор або інтерактивної літератури для вебу та десктопу. Він використовує Ink для описання сценарію гри та JavaScript+CSS для його виконання та оформлення.

Більша частина цієї документації описує створення ігор за допомогою Atrament Web UI.

Приклад гри, зробленої на Атраменті - "The Coiled Crown":

"The Coiled Crown"

Компоненти

Атрамент складається з декількох JS бібліотек та застосунків: Atrament Core, Atrament Web, Atrament Web UI та Atrament Wizard.

Найпростіший спосіб створити власну гру за допомогою Атраменту - скористатися Atrament Web UI, який пропонує готовий для використання ігровий рушій з багатьма можливостями. Досвідчені розробники можуть використати в своєму веб-застосунку бібліотеку Atrament Web, або скористатися бібліотекою Atrament Core для створення застосунків для NodeJS чи використання власного набору сторонніх бібліотек.

Atrament Core

Atrament Core - це обгортка навколо InkJS, яка пропонує базову функціональність і може бути використана з будь-якими сторонніми бібліотеками. Вона керує станом гри, обробкою тегів, сховищем даних та звуком. Вихідний код, NPM пакет.

Atrament Web

Atrament Web - це бібліотека для браузерів, яка використовує nanostores для збереження стану гри, localforage в якості сховища даних та howlerjs для керування звуком. Її можна використовувати в будь-яких веб-застосунках. Вихідний код, NPM пакет.

Atrament Web UI

Atrament Web UI - це веб-застосунок, написаний на Preact (веб-фреймворк, схожий на React), який допомагає створювати ігри для вебу та десктопу:

  • контролює користувацькі сесії, збереження та завантаження ігор, контрольні точки;
  • додаткова розмітка: блоки, таблиці, повідомлення, заголовки, індикатори прогресу, продовження по кліку тощо;
  • додаткові інтерактивні елементи - кнопки та поля вводу;
  • можливість створювати додаткові екрани для інвентарю, характеристик персонажа і т.д. за допомогою оверлеїв;
  • підтримка мультимедіа: зображення, фони, звуки, музика та відео;
  • відлагодження: ви можете передивлятися та редагувати змінні, запускати функції в Ink і т.д.;
  • змінювані теми оформлення, шрифти та CSS стилі;
  • експорт гри у веб-застосунок, одиночний файл HTML (як Twine) або як застосунок для десктопних операційних систем

Вихідний код, демонстрація можливостей.

Atrament Wizard

Atrament Wizard - це утиліта командного рядка для проєктів на Атраменті, яку можна запустити за допомогою npx:

npx atrament-wizard

Вихідний код, NPM пакет.