Добавлен README

KeyJ148 · Jan 30, 2023 · 4e2bb67 · 4e2bb67
1 parent 60f159d
commit 4e2bb67
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/Assets/CursedLogo.png b/Assets/CursedLogo.png
diff --git a/Assets/RepairMessage.png b/Assets/RepairMessage.png
diff --git a/Assets/Structure.png b/Assets/Structure.png
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+![Cursed Logo](/Assets/CursedLogo.png)  
+# Набор костылей и велосипедов для кодинга в Space Engineers
+> Бронух, пожалуйста, хватит! Остановись!
+
+## Требования для работы
+- Для работы с репозиторием необходим Visual Studio 2019 с установленным.
+- Расширение [MDK-SE](https://github.com/malware-dev/MDK-SE) для VS 2019 (_которого нет для VS 2022_).
+- Установленная лицензионная копия Space Engineers.
+
+## Подготовка к работе
+Если решение запускается впервые, то сначала необходимо восстановить пути MDK. Через 10-20 секунд после запуска решения в Visual Studio появится окно с предложением о восстоновлении проектов.
+![Сообщение MDK](/Assets/RepairMessage.png)  
+Нажмите `Repair`, чтобы восстановить пути к игровым библиотекам.
+
+## Работа со скриптами
+### Помните, что Space Engineers не позволит запустить на одном блоке код, содержащий более **_100 000_** символов.  
+Используйте [сжатие кода](https://github.com/malware-dev/MDK-SE/wiki/The-Minifier) в `/MDK/MDK.options.props`, чтобы значительно сжать код.
+```xml
+<MDKMinify>
+    <Level>Full</Level>
+</MDKMinify>
+```
+
+### В Visual Studio проект будет иметь следующую структуру
+![Структура](/Assets/Structure.png)  
+Раздел `Libs` содержит общие библиотеки для скриптов. При развертывании скриптов, весь исходный код используемх библиотек будет добавлен в конец скрипта. Помните про _100 000_ символов. Две библиотеки без сжатия используют **_10 000 - 15 000_** символов.  
+
+Раздел `Scripts` содержит непосредственно запускаемые скрипты.