Устарело!

Используйте актуальный учебник!

---

Minecraft Modding Book

В этом репозитории находятся исходники статей и движка сайта.

Вклад в учебник

Правки в статьи

Если вы заметили ошибка в статье, или просто считаете, что можете объяснить какую-то тему лучше, чем это сделано в статье, то у вас есть два пути.

Через Pull Request (предпочтительно)

На сайте сверху справа статьи есть кнопка "Редактировать". Кликнув на нее вы перейдете к файлу статьи в markdown формате.

Измените этот файл так, как вы хотите и создайте pull request. Мы проверим ваши изменения и, если все хорошо, примем их!

Через Issues

Расскажите об ошибке путем создания новой Issue во вкладке Issues. Так вы дадите нам знать, что нашли ошибку. Мы исправим ее и закроем Issue.

Запрос статьи/функции на сайте

Если вам нехватает статьи по какой-то теме или вы считаете, что функционал сайта можно расширить, то откройте новую Issue во вкладке Issues.

Максимально подробно опишите тематику предлагаемой статьи/категории. Если речь идет о новом функционале для сайта, то не забудьте упомянуть, почему вы считаете, что предлагаемая вами фича будет полезна.

Написание собственного контента

Для начала сделайте форк данного репозитория. Эта операция создаст клон данного репозитория, но уже под вашим контролем. Можно начинать работать. После того, как все готово, создавайте pull request. Мы все проверим и, если все хорошо, примем вашу статью.

Если у вас есть доступ к данному репозиторию, то вам достаточно создать новую ветку.

Добавление статьи

Статья на вики.

Добавление категории

Предположим, что вы хотите создать категорию "Сущности" в которой будет несколько ваших статей: про создание моба и босса. Все это под Minecraft версию 1.11+ и с помощью Forge.

Переходим по пути book\1.11+\forge. Создаем здесь папку entities.

Внутри папки обязательно должен быть файл config.yml.

Образец конфигурационного файла категории:

# Category title
category-title: Сущности

# Articles order
articles-order:
  - creating_mob
  - creating_boss

Далее создаем две папки (creating_mob и creating_boss) для двух статей про моба и босса соответственно. Делаем статьи по инструкциям выше.

Теперь надо добавить вашу категорию в список категорий. Для этого, в папке API откройте файл config.yml и добавьте директорию своей категории в список categories-order. Позиция категории в этом списке имеет значение.

Добавление API

Предположим, вы хотите написать ряд статей про создание модов для Minecraft версии 1.11+ с помощью Forge.

Переходим по пути book\1.11+. Создаем здесь папку forge.

Внутри папки обязательно должен быть файл config.yml.

Образец конфигурационного файла API:

# API name
api-name: Forge

# Categories order
categories-order:
  - entities
  - GUI

Далее создаем две папки (entities и GUI) для двух категорий про сущности и GUI соответственно. Делаем категории по инструкциям выше.

Добавление версии

Предположим, вы хотите создать свой учебник для Minecraft версии 1.11+.

Переходим в папку book и создаем здесь папку 1.11+.

Внутри папки обязательно должен быть файл config.yml.

Образец конфигурационного файла версии:

# Version number
number: 1.11+

# Development state: Release, Beta, Alpha
dev-state: Release

# Default API directory
default-api-dir: forge

Далее обязательно создаем папку forge для API по умолчанию и любые другие папки для других API. Создаем API по инструкциям выше.