TODO.md

Запланированный контент

С чего начать?

Просто набросайте примерное содержание статьи, определиться к какой группе она относится никогда не поздно.

Использование API в примерах

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

Базис

• getCoreAPILevel
• getMCPEVersion

События

Потоки и взаимодействие с ними:

• runOnMainThread
• runOnClientThread
• Threading

Прочее:

• Network (упомянуто в блоках, но должно быть и здесь)
• NetworkEntity
• NetworkEntityType
• NetworkConnectedClientList
• SyncedNetworkData
• Callback
• Updatable
• Game
• Commands

Предметы

• IDRegistry
• ItemID
• Item (ItemRegistry)
• Recipes
• ToolAPI
• Armor (ArmorRegistry)
• TagRegistry
• CustomEnchant
• Translation

Блоки

• BlockID
• Block (BlockRegistry)
• ItemModel
• BlockRenderer
• ICRender
• LiquidRegistry
• NBT

Окружение

• World (WorldAPI)
• BlockSource
• BlockState
• GameObject
• GameObjectRegistry
• Animation (AnimationBase, AnimationItem)
• Particles (ParticleAnimator)

Существа

• Entity (EntityAPI)
• PlayerActor
• Render (RenderAPI)
• AttachableRender
• ActorRenderer

Измерения

• GenerationUtils (WorldGenerationUtils)
• Dimensions
• CustomBiome

Хранилище

Клиентское и серверное:

• Config
• Saver (SaverAPI)

Контейнеры и тайлы:

• ItemContainer
• TileEntity

Прочее:

• FileTools
• Resources

Интерфейсы

• UI

Продвинутое

• WorldRenderer

Публикация

Отладка и поиск ошибок:

• Debug
• Logger
• LowLevelUtils (MCSystem)
• alert (print)

Создание интеграций с другими проектами:

• ModAPI

Устарело (вероятно)

• MobRegistry
• MobSpawnRegistry (EntitySpawnRegistry)
• AddonEntityRegistry
• Texture
• EntityModel
• EntityModelWatcher
• EntityAIClass
• EntityAIWatcher
• EntityAI
• Player (PlayerAPI)
• IDData
• Native

Прогресс переработки старой документации

Репозиторий не базируется на ней, но направления некоторых статей могут быть схожи.

• Построение модов
  • Структура модов
  • Стандартный шаблон модов
  • Ресурсы (разделено по категориям)
  • Компиляция в байткод
  • Базовые методы и переменные исполняемых файлов
  • Библиотеки
• Глобальные методы и переменные CoreEngine
• События в игре. Модуль Callback
  • Модуль Callback
  • Список коллбеков
  • Список названий ванильных экранов
• Блоки и предметы
  • Создание блоков и предметов
  • Стандарт Именования Inner Core (разделено по категориям)
  • Продвинутое создание блоков и предметов
  • ToolAPI
  • Рендер блоков
  • Визуальная составляющая ICRender
  • Форма блоков
  • Класс RenderMesh
  • Дополнительные данные предмета
  • Случайные обновления блоков
  • TileEntity
  • Рецепты
  • Жидкости и работа с ними
  • Броня
• Модуль World
• Генерация
  • Модуль GenerationUtils
  • Основы генерации
• Модуль Game
• Сущности
  • Модуль Entity
  • Список ванильных рендеров
  • Создание мобов
  • Пример создания моба
  • Кастомные мобы
• Модуль Player (устарело)
• GUI
  • Модуль UI
  • Введение в GUI
    • Стандартный интерфейс
    • Однооконный интерфейс
    • Многооконный интерфейс
  • Контейнеры
  • Динамичный интерфейс
• Модуль ModAPI
• Модуль Updatable
• Модуль GameObject
• Анимации
• Отладка (достаточно одной статьи для описания принципов)
  • Модуль Logger
  • Модуль Debug
• Модуль Particles
• Модуль FileTools
• Модуль SaverScope
• Модуль Translation
• Многопоточность

Общий прогресс статей

• Intro (80%)
• Getting Started
  • Methodology (100%)
  • Installing Pack (100%)
  • Supporting IDEs (60%)
  • Going Forward (80%)
• Basics
  • Mod Structure (95%)
  • Mod Lifecycle (100%)
  • Building Script (100%)
  • Evaluate Context (100%)
  • Integrating Libraries (100%)
• Events
  • Callbacks (75%)
  • Where, What and Who (75%)
  • Updatables (100%)
  • Threading (75%)
  • Using Synced Data (0%)
• Items
  • First Item (100%)
  • Food Armor and Throwables (100%)
  • Recipes (100%)
  • Extra
    • What is Extra (0%)
    • Enchanting (0%)
  • Tools (0%)
• Blocks
  • First Block (95%)
  • First Liquid (50%)
  • Renders
    • Vanilla Shapes (100%)
    • Block Renderer (100%)
    • Conditioning (0%)
    • Customizing Item (0%)
  • Block Entities (0%)
• Environment
  • Modifying Region (90%)
  • Game Objects (0%)
  • Animation (0%)
  • Particles (60%)
• Entities
  • Actoring Entities (100%)
  • First Entity (100%)
  • Renders
    • Rendering Basics (0%)
    • Animating in Runtime (0%)
    • Attaching Renders (0%)
  • Path Navigation (0%)
• UIs
  • Investigating Contents (95%)
  • Window Types (15%)
  • Drawings (100%)
  • Elements (100%)
  • Extending Components (95%)
• Storage
  • Saving Basics (100%)
  • Containers (0%)
  • Tile Entities (10%)
  • Processing Resources (0%)
• Dimensions
  • Ore with Manual Generation (25%)
  • First Dimension (0%)
  • Creating Biomes (0%)
  • Investigating Generators (0%)
• Structures
  • First Structure (0%)
  • Setting Up Features (0%)
  • Blueprinting (0%)
  • Pools and Jigsaws (0%)
• Advanced
  • Named Binary Tag (0%)
  • Wrapping Packages (0%)
  • Shaders and Materials (0%)
  • C++ Modding (0%)
• Publishing
  • Connecting Integrations (0%)
  • Debugging (0%)
  • Packing to Publish (0%)
  • Uploading and Community (0%)
• Future Steps (0%)