Feat: Добавлена документация по основным методам DungeonUtility #11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaXFeeD
requested changes
Aug 23, 2024
docusaurus.config.js
Outdated
| @@ -26,6 +26,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/vsDark'); | |||
| const logger = require('@docusaurus/logger'); | |||
| const path = require('path'); | |||
| const fs = require('fs'); | |||
| const sidebars = require('./sidebars'); | |||
Comment on lines
+252
to
+274
| 'libraries/DungeonUtility/getting-started', | ||
| { | ||
| type: 'category', | ||
| label: 'Upload Structure', | ||
| link: { | ||
| type: 'generated-index' | ||
| }, | ||
| items: [ | ||
| 'libraries/DungeonUtility/loaders/StructureFormats', | ||
| 'libraries/DungeonUtility/loaders/StructureLoader', | ||
| ] | ||
| }, | ||
| { | ||
| type: 'category', | ||
| label: 'Structure Generation', | ||
| link: { | ||
| type: 'generated-index' | ||
| }, | ||
| items: [ | ||
| 'libraries/DungeonUtility/generations/ItemGeneration', | ||
| 'libraries/DungeonUtility/generations/StructurePiece' | ||
| ] | ||
| } |
There was a problem hiding this comment.
Просьба в будущем использовать kebab-раскладку при указании путей файлов, папок и прочего как в основной документации (допускается использование snake_раскладки для файлов к загрузке в документации)
There was a problem hiding this comment.
Братан, какие кебабы, я не понимаю о чем ты
Я делал методом тыка 🏳🗿
There was a problem hiding this comment.
Эти: 1. camelCase ; 2. snake_case ; 3. kebab-case ; 4. PascalCase.
| ## Зачем существуют различные форматы структур? | ||
|
|
||
| Dungeon Utility изначально писался как часть модификации Ancient Wonders/Dungeon craft. | ||
| В случае Ancient wonders, данный мод имел 3 различные библиотеки для структур, что было весьма не красиво с точки зрения истеки и поддержки мода. |
There was a problem hiding this comment.
Suggested change
| В случае Ancient wonders, данный мод имел 3 различные библиотеки для структур, что было весьма не красиво с точки зрения истеки и поддержки мода. | |
| В случае Ancient wonders, данный мод использовал несколько различных библиотек для структур, что было неприемлемо с точки зрения поддержания работы мода. |
| В случае Dungeon craft, мод всегда использовал только одну библиотеку структур, они использовали разные форматы структур, переход был пусть и простым делом, но в один момент при конвертации форматов произошла ошибка, которая была замечена уже после. | ||
|
|
||
| DungeonUtility предлагает быстрый переход с разных библиотек, без проблем с форматом структур! | ||
| Примером данного перехода является мод Aether 2 BE, Ancient wonders |
There was a problem hiding this comment.
Для примеров указываются моды с исходным кодом или по крайней мере обновленные в браузере
| Первый short - это позиция разреза по координате z | ||
| второй и третий short - размеры двух мерного массива | ||
|
|
||
| Двух мерный массив содержит **id состояния**, каждая позиция в массиве это кордината блока в структурк, также необходимо вычесть X_OFFSET и Y_OFFSET из DESCRIPTION |
There was a problem hiding this comment.
Suggested change
| Двух мерный массив содержит **id состояния**, каждая позиция в массиве это кордината блока в структурк, также необходимо вычесть X_OFFSET и Y_OFFSET из DESCRIPTION | |
| Двухмерный массив содержит **идентификатор состояния**, каждая позиция в массиве это координата блока в структуре, также необходимо вычесть X_OFFSET и Y_OFFSET из DESCRIPTION |
|
|
||
| ## Какой формат лучше использовать? | ||
|
|
||
| Формат DungeonUtility - является форматом, **который используется везде по умолчанию**, имеет один жирный минус, большой вес файла. |
There was a problem hiding this comment.
Suggested change
| Формат DungeonUtility - является форматом, **который используется везде по умолчанию**, имеет один жирный минус, большой вес файла. | |
| Формат DungeonUtility является форматом, который используется **для загрузки по умолчанию**, однако имеет один жирный минус — большой размер файла. |
| Формат DungeonUtility - является форматом, **который используется везде по умолчанию**, имеет один жирный минус, большой вес файла. | ||
|
|
||
| Формат DungeonUtility_V2 - является новым форматом, который имеет достаточно компакнтый размер, при этом обладает неплохой скоростью загрузки. | ||
| Особенностью данного формата являются: что он [бинарный файл](https://en.wikipedia.org/wiki/Binary_file), хорошая безопасноть - иногда происходит повреждение части информации на носителе(увы и ах от этого не кто не застрохован) в случае если часть файла все-же повредилась, есть шанс что хотя-бы половина структуры загрузиться нормально. |
MaXFeeD
changed the title
MaXFeeD
approved these changes
Aug 23, 2024
| Для того, чтобы не добавлять свои предметы вручную в каждый мод на структуры был добавлен метод: | ||
|
|
||
| ```ts | ||
| ItemGeneration.setItemIntegration(VanillaItemID.diamond_axe, .1, {min: 1, max: 1}); |
There was a problem hiding this comment.
Comment on lines
+77
to
+78
| ItemGeneration.addItem("example_generator", VanillaItemID.iron_ingot, .5, {min: 1, max: 3}); | ||
| ItemGeneration.addItem("example_generator", VanillaItemID.diamond, .1, {min: 1, max: 1}); |
There was a problem hiding this comment.
| }); | ||
|
|
||
| // Добавляем предмет во все другие моды | ||
| ItemGeneration.setItemIntegration(VanillaItemID.diamond_axe, .1, {min: 1, max: 1}); |
There was a problem hiding this comment.
|
|
||
| [TypeScript декларации](https://github.com/Reider745/Dungeon-Utility/tree/main/declarations) - требуются для подсказок в [toolchain](https://github.com/zheka2304/innercore-mod-toolchain) | ||
|
|
||
| Данная документация содержит только основные методы, без дополнительных усложнений, для простоты понимания, документация расчитана на тех кто уже [JavaScript](https://learn.javascript.ru/) |
Comment on lines
+82
to
+90
| # Моды которые используют DungeonUtility | ||
|
|
||
| + [Desolation](https://icmods.mineprogramming.org/mod?id=784) | ||
| + [Schematic](https://icmods.mineprogramming.org/mod?id=786) | ||
| + [AppliedEnergistics 2](https://icmods.mineprogramming.org/mod?id=906) | ||
| + [Example Structure](https://icmods.mineprogramming.org/mod?id=992) | ||
| + [Galacticraft 4 PE](https://icmods.mineprogramming.org/mod?id=8556) | ||
| + [Ancient wonders](https://icmods.mineprogramming.org/mod?id=682) | ||
| + [Aether 2 BE](https://icmods.mineprogramming.org/mod?id=195) |
| ## Почему StructureLoader Устарел? | ||
|
|
||
| Все мы любим назвать свое единственное дерево в моде 'бревно265', что будет если в двух разных модах будет структура 'бревно265'? | ||
| Очень просто, выживит сильнейший! |
There was a problem hiding this comment.
Suggested change
| Очень просто, выживит сильнейший! | |
| Очень просто, выживет сильнейший! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.