Guidebook.md

Этот мод значительно упрощает процесс создания руководств для разработчиков модов BTA, предоставляя удобные инструменты работы с Markdown и дополнительные функциональные возможности.

Основные возможности

Мод позволяет создавать интерактивные руководства с использованием расширенного синтаксиса Markdown. Вы можете наследовать класс MDBookScreen, загружать конфигурации из путей ресурсов и работать с файлами формата .md как с обычными экранами, которые активируются через триггеры.

Форматирование текста

Для цветового оформления текста используются специальные символы:

- 0 = &0Черный
- 1 = &1Темно-синий
- 2 = &2Темно-зеленый
- 3 = &3Темно-бирюзовый
- 4 = &4Темно-красный
- 5 = &5Темно-фиолетовый
- 6 = &6Золотой
- 7 = &7Серый
- 8 = &8Темно-серый
- 9 = &9Синий
- a = &aЗеленый
- b = &bБирюзовый
- c = &cКрасный
- d = &dСветло-фиолетовый
- e = &eЖелтый
- f = &fБелый
- s = &sТень
- r = Сброс

Синтаксис Markdown

Поддерживается стандартный синтаксис Markdown, адаптированный для формата BTA Guidebook:

# Заголовок 1
## Заголовок 2
### Заголовок 3
#### Заголовок 4
##### Заголовок 5
###### Заголовок 6
* Неупорядоченный список
- Неупорядоченный список
1. Упорядоченный список

Работа с изображениями

Изображения
- текст(ширина,высота,тип)
- 
- ![верстак](empty,empty,empty,empty,empty,empty,empty,empty,empty, empty)

• Ширина и высота указываются в пикселях
• Тип может быть default | icon или оставлен пустым для использования опции по умолчанию
• Последний слот верстака предназначен для выходного предмета

Практическое применение

Создание руководства на Markdown

public class MyBook extends MarkdownGuidebook<MDPage> {

    public IntroBook() {
        String path = "/assets/modid/markdown/mybook/";
        config = BookConfig.fromJsonResource(getClass(), path + "config.json");

        DecimalFormat formatter = new DecimalFormat("000");
        for (int i = 0; i<11; i++) {
            String fileName = "page_" + formatter.format(i + 1) + ".md";

            loadMarkdownPages(path + fileName);
        }
    }
}

Отображение Markdown

Дополнительную информацию можно найти в суперклассе.

public class MyMDScreen extends MDScreen {
    public MyMDScreen() {
        currentPage = MarkdownCompiler.compile("/assets/modid/markdown/path/to/your/file.md", getClass());
    }
}

Встроенный редактор Markdown

Используйте редактируемую книгу непосредственно в игре и экспортируйте содержимое в формате Markdown для использования в ваших проектах! Также этот инструмент отлично подходит для обмена информацией с друзьями в вашем мире!

Команды

Экспорт и загрузка книг в формате Markdown.

• Используйте: /guidebook export <название>

  • для экспорта в: btafolder/guidebook/exported/<название>

• Используйте: /guidebook load <название>

  • для загрузки из: btafolder/guidebook/load/<название>

Демонстрация

Загрузите архив с файлами на странице релиза