Готовый перевод Story emulator / Эмулятор историй: Instruction (Инструкция)

Как это работает?

Итак, всего есть три ключевых элемента (на данный момент).

1. Текстовый файл с историей (пример такого файла можно найти в папке "texts" внутри папки с эмулятором). Данный файл является ключевым, так как здесь помимо самой истории так же расположены инструкции для эмулятора, которые помогают ему понять, что вы хотите сделать с текстом внутри файла.

2. Изображения (в настоящий момент поддерживаются лишь jpg-файлы). Изображения необходимо поместить в соответсвующую подпапку папки "image": "locations" (сцены), "interface" (элементы интерфейса эмулятора) или "characters" (персонажи).

3. Сам эмулятор. По большей части эмулятор нацелен уже на читателя или игрока, для авторов там пока нет ничего особо интересного. Разве что они сами пожелают увидеть результаты своих стараний.

=====================================

Начнем по порядку - с текстового файла и его разметки. (данный раздел будет интересен в первую очередь авторам и создателям контента)

Текстовый файл должен иметь расширение .txt (в настоящий момент поддерживается лишь этот формат).

Текст внутри файла должен быть организован определенным образом. 

Прежде, чем разбирать шаблон построения текста в файле даваетй разберемся с некоторыми обозначениями в нем:

1. s1 - где "s" сокращение от  "scene"/"сцена", а "1" - указывает порядковый номер сцены. Сцена - это описание того, где происходят события, поэтому, обычно в качестве сцены выступают изображения.

2. е1 - где "е" сокращение от "episode"/"эпизод", а "1" - указывает на порядковый номер эпизода. На одной сцене можент происходить множество эпизодов, поэтому важно учитывать этот момент. Это так же один из ключевых элементов для организации переходов между сценами в интерактивных историях.

3. h0 - обзначение главного героя. Все реплики главного героя должны начинаться с этого обозначения.

4. m0 - обозначение мыслей (по умолчанию) главного героя.Все реплики мыслей должны начинаться с этого обозначения.

5. d0 - обозначение диктора. Обычно текст, который описывает обстановку, что-то поясняет и т.д. Все реплики диктора должны начинаться с этого обозначения.

6. n0 - обозначение не игровых персонажей (npc), число обозначает уникальный номер персонажа. То есть, n0 и n1 - это два разных персонажа. Все реплики не игровых персонажей должны начинаться с их уникального идентификатора.

7. ==> - данный символ указывает на начало нового раздела истории с указанием стартовой сцены и эпизода. Данный символ является строго обязательным при написании истории, включая заключительную стрелку "==> End!". Без этого символа стабильная работа эмулятора не гарантируется. (не использовать в обычном тексте!)

8. $ - является обязательным символом, который отделяет строку команд от основого текста. (не использовать в обычном тексте!)

9. btn3 - обозначение для указания количества кнопок. В данном случае подразумевается, что в вызванной сцене необходимо создать 3 кнопки. Следующие три строки за строкой, где была использована эта инструкция являются с точки зрения эмулятора кнопками. Поэтому есть смысл писать там текст, который вы желаете увидеть в кнопках. По этой же причине, следующие три строки имеют обязательный атрибут btnХ. Он позволяет понять эмулятору, что это не часть текста, а кнопка.

10. s1/e5 - подобные обозначения обязательны для "кнопок". Они указывают на какую сцену и эпизод необходимо совершить переход в случае нажатия на эту кнопку. Важный момент, что сцена и эпизод должны быть обязательно разделены символом деления "/". Не соблюдение этого правила приведет к ошибкам в работе эмулятора.

11. n0.name - приставка ".name" в сочетании с уникальным идентифмкатором в тексте позволяет эмулятору подставлять имена персонажей в текст.

в целом, структура построения текста в файла должна иметь следующий вид:

==> s3.e1. (п.а. сцена 3, эпизод 1)
h0.$ Хотите узнать больше? Отлично!

h0.$ Тогда я передам слово своей подруге, которая введет тебя в курс дела!

h0.$ Знакомтесь, это n1.name!

n1.$ Всем привет! Приятно познакомиться!

n0.$ Эй, и про меня не забудьте!

h0.$ О, n0.name, ты тоже здесь? Отлично!

n12.$ Ахах! Готова поспорить, что меня вы здесь не ожидали увидеть!

h0.btn1$ Это точно, n12.name!

s3/e1.btnX$ Далее
==> End! (п.а. конечная стрелка истории. Всегда ставиться на последней строке текстового файла.)

п.а. текст в скобках является комментариями, его не нужно использовать при написании истории. Для более полного понимая того, как должен быть оформлет текстовый файл, загляните в раздел "Example txt-file (Пример оформления текстового файла)".

Текстовый файл может распологаться где угодно на ПК, но для его загрузки в эмулятор нужно вопспользоваться кнопкой "Открыть файл" внутри эмулятора.

Внимание! Этот перевод, возможно, ещё не готов.

Его статус: идёт перевод

http://tl.rulate.ru/book/108741/4030819