Каталог статей, Гайды и статьи, Atom RPG

Вводный курс по использованию ModKit (ATOM RPG)


Автор:
  Дата публикации: 22.03.2019, 07:45 · 18 161 · 0

  1. Описание

Предисловие

Данная инструкция написана мной (phobos2077) на основе того как я сам понял использование инструментария. Т.к. я не разработчик, мог чего-то не понять или понять неверно, имейте ввиду.

ModKit для ATOM RPG реализован в виде Unity-проекта (Unity - движок, на котором работает игра). Это значит что инструментарий работает только внутри запущенного редактора Unity. Поэтому первым делом нужно установить нужную версию редактора.
ModKit поставляется (на момент написания) в комплекте с файлами ресурсов игры, которые можно извлечь для редактирования. Пока там не все ресурсы, нет статики (текстур, моделей и т.п.). Т.е. вы работаете с копией ресурсов, которая не связана с установленной игрой ATOM RPG.

Моды созданные в ModKit представляют собой AssetBundle (по сути архив с дополнительными игровыми ресурсами в определенном формате, понятном Unity) + файл DLL (код мода).
Игра версии 1.08+ (либо бета-бранч) автоматически загружает моды, установленные в следующей папке:
c:\Users\<USERNAME>\AppData\LocalLow\AtomTeam\Atom\Mods\

Установка Unity

https://unity3d.com/ru/get-unity/download?ref=personal​​​​​​​



Вариант 1 (рекомендуемый, но требует установки еще одной проги)
- "Загрузить Unity Hub"
- Скачиваем, устанавливаем, запускаем
- Нажимаем Installs -> Official Releases -> Download (Напротив версии 2018.3*)



- В следующем окне ничего отмечать не нужно, жмем "Done"



- Дожидаемся скачивания и установки Unity
(этот вариант позволит в будущем легко устанавливать новые версии Unity, а также держать 2 и более версий на компе)

Вариант 2
- "Загрузить установщик"
- Скачиваем, следуем инструкциям установщика

После первого запуска потребуется авторизация. Необходимо будет создать учетную запись Unity

 

Коротко об использовании Unity Editor



Стандартный оконный интерфейс. Вверху главное меню редактора, под ним тулбар с полезными инструментами для разработки игр. Большую часть всего этого знать не обязательно, если вы планируете делать простые моды (правку предметов, диалогов и т.п.). 

Для разработки полноценных новых локаций потребуются базовые навыки разработки сцен в Unity (в интернете миллион туториалов на эту тему).

Основная часть окна поделена на несколько областей, каждая из которых может иметь несколько вкладок. Каждая вкладка это "окно" внутри редактора Unity, их можно перетаскивать как угодно (в другую область, в отдельное от основного редактора окно и т.п.). Размеры областей также можно менять. На скриншоте представлена стандартная раскладка, которая идет после установки. 

Рассмотрим основные окна.
1. Hierarchy/Иерархия - тут все объекты в открытой сцене. По умолчанию открыта пустая сцена Untitled. 
2. Scene/Сцена - 3D-представление сцены.
3. Project/Проект - дерево папок вашего проекта, с правой части показаны (4) ассеты (файлы игры) в выбранной папке.
5. Inspector/Инспектор - показывает свойства объекта, выбранного либо в сцене, либо в проекте. Самое важное для нас окно.

Готовим проект к разработке модов

https://github.com/atomrpg/modkit

- Нажимаем "Clone or download" -> "Download ZIP"



- Извлекаем папку "modkit-master" из архива
- Запускаем Unity
- (авторизуемся, если потребует)
- Жмем "Open"



- Выбираем нужный каталог



- После загрузки, главное окно редактора будет выглядеть примерно так:



- В меню выбираем Game -> Asset Viewer



- Увидим такое окно:



- Для удобства можем перетащить вкладку AssetViewer из этого окна в главное окно (рядом с Game, Scene, и тд)

В проекте modkit сразу идут ресурсы "примерного" мода. На первый раз рекомендуется ознакомиться с этими ресурсами, попробовать собрать мод и проверить его в игре. Но для дальнейшей разработки вашего мода нужно будет удалить всё лишнее, чтобы в готовом моде были только нужные ассеты.
Для очистки всего лишнего удаляем ТОЛЬКО следующие каталоги:
- Все подпапки в папке Resources/
- Все ассеты в папке Scenes/

Проект почищен, но мод работать не будет если не настроить должным образом скрипт мода.
- В проекте выбираем каталог Scripts/
- Щелкаем по MyMod и в инспекторе меняем поле Name на имя фашего мода (латиницей, без пробелов и лишних символов).



- Щелкаем в любое другое окно, появится сообщение "Unapplied import settings", выбираем "Apply".
- Ждем пока редактор пересобирёт скрипты.
- Щелкаем по ModEntryPoint правой кнопкой - "Show in Explorer". 
- В проводнике открываем файл ModEntryPoint.cs текстовым редактором:



- В данном скрипте разработчики добавили код необходимый для запуска того самого "примерного" мода с новой локацией. Нам же большая часть этого кода не нужна. Для новичков рекомендую заменить всё содержимое скрипта на мой вариант:
https://pastebin.com/VbBZ6U8w

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

Использование Asset Viewer



В окне AssetViewer в верхней части есть следующие элементы:
- Кнопка Reload - перезагружает ассеты из ресурсов (идут в комплекте с modkit)
- Поле поиска (2) - для фильтрации ассетов по имени
- Поле выбора категории (1) - для фильтрации по категориям ассетов

Для правки ассета сначала нужно его скачать в проект, для этого нажимаем правой кнопкой мыши -> Download. Выбранный ассет и все его зависимости (иконки, звуки и т.п.) подтянутся в проект:



Также AssetViewer можно использовать для просмотра ассетов (если не требуется их править), для этого просто щелкаем левой кнопкой мыши по ассету и смотрим его свойства в окне Инспектора.

Правка предметов при помощи ModKit

- По инструкции "Готовим проект.." настриваем проект мода и используем предложенный ModEntryPoint.cs
- По инструкции из раздела "Использование AssetViewer" скачиваем нужный предмет, в данном примере это будет АКМС.
- В проекте выбираем Resources/entities/weapon/ - ассет "akms" (тот что с логотипом Unity - это и есть описание предмета)
- Правим нужные характеристики, например урон (Damage Min/Max)



- Всё, правка готова, осталось лишь собрать мод

Сборка и тестирование мода

- В главном Unity меню выбираем "Game" -> "Build Mod"
- Вводим имя мода (ВАЖНО! должно совпадать с тем что мы указали в Scripts/MyMod в поле "Name", иначе работать не будет!)
- Нажимаем BUILD
- После успешной сборки откроется папка Mods с созданным модом. Убедитесь что имя DLL и созданной папки совпадают между собой и с тем что вы вводили:



​​​​​​​- Запускаем игру, изменения мода должны вступить в силу
- Если что-то не сработало, открываем логи игры:
C:\Users\Killian\AppData\LocalLow\AtomTeam\Atom\output_log.txt
- Ищем строку "Mod Init: SuperAK" либо просто имя вашего мода. Если найдено, значит мод собран и загружен успешно.
Информация
Посетители, находящиеся в группе Гости, не могут оставлять комментарии к данной публикации.

Категории

Чат доступен только для зарегистрированных пользователей. Войдите в аккаунт для общения в чате.

Лента комментариев

Мод обновлён под версию 121+

Сегодня, 13:20

 Пишет,что нет патчей



 



Крч, именно патчи разорхивировать нужно было. Проблема решена.

Сегодня, 13:19

Попробуйте последовательно установить обновления: 121.372... и только потом финальный патч 122... Те вытащите из папки патчера сначала все что не касается к 372, установите. Потом вытащите все что к 372 и верните файлы только для 122

Сегодня, 12:29

Арос фикс обновил ...218... на офсайте

Сегодня, 12:26

ModKit теперь поддерживает модификации для анимаций, аксессуаров и лиц. // ;)))

 

Сегодня, 12:23

Я не в этом плане, а в том, что иногда ошибаются на "Операция каждый раз одна и таже" даже игроки с опытом.

Сегодня, 12:06

Всем привет!! Помогите пожалуйста разобраться. Вроде все делаю правильно, но версия игры не обновляется.

У меня сейчас версия 1.121.361.1020

1) Скачала Кряк для 1.122.212.1030 и Кряк для 1.121.372.1020

2) Скачала Патч 1.122.212.1030 и Патч 1.121.372.1020

3) Скачала  офлайн Patcher

4) Закинула все файлы из пп 1 и 2 в папку патчера (не разархивировала)

5) Запустила Patcher. Получила критическую ошибку " не хватает DLC"

6) Скачала и закинула в папку патчера нужные DLC

7) Запустила Patcher. Он увидел DLC и предложил установить

Итог: DLC лежат в папке с игрой, все ок. НО версия игры по-прежнему 1.121.361.1020

Подскажите пожалуйста, что я делаю не так??dapizdecdapizdec

Сегодня, 11:55

20-21 в процессе создания (автор их ещё не выпустил).
2.985 - https://modsfire.com/Ub6JLPLX24BcMnD

Сегодня, 11:14

Попробовал через Mod Settings Menu сделать отображение инфомрации и пару функций на сбросы. Но при каждом открытии меню, у сима наблюдается рост стресса даже на паузе. Учитывая что "изменения" не должны вноситься, видимо что-то куда-то лезет, куда не следует.
И пока никак это не победил. Сим стрессует, я стрессую, пока плюнул на это дело.

Сегодня, 10:18

А где скачать предыдущие версии (интересует 2.985). А то у меня на Симах 1.119 что-то ошибки постоянно летят от этой весрии.

 

И кстати функционала не хватает. Нет пункта пройти тест на отцовство (в версии 2.984 также нету этого пункта).

 

И еще вопрос: а где скачать модули 20-21 для 2.986? (в архиве их нету).

Сегодня, 10:05

Может оно и к лучшему что допов больше не будет) Их "гениальная" идея всегда состоит втом чтоб сломать нам игру.

К примеру эти «Сквозь века» мне сломали все супружеские связи и родственные отношения даже на стандартных семьях.

Каким же это надо быть дегенератом чтоб взять и переписать код игры под очередное "гениальное" дополнение на 10-ом году игры, зная то что у игроков есть сохранения которым также по 10-ть лет.
Моей сохре два года и всё это накрылось медным тазом потому что в ЕА ничего лучшего не придумали как переписать код на генеалогическое древо. Как раз этого нам и не хватало в игре, какбуд-то симс будут не симс если в них не будет семей Монтеки и Капулети.😂

Какие же эти дятлы из ЕА тупые и убогие это просто пи..ц. interesno

Сегодня, 09:49

All4You

 

Было дело, но всего один раз.😁 Так что меня к категории "я фсьо сделал(а) привильна, а ана ниработаит" не приписывайте. 😆

Сегодня, 09:07

Не будет конфликтовать с модом что Нпс только в своих городах появляються ?

 

Сегодня, 08:14

Подскажите кто понимает =) В моде всего два пункта 1. менеджер по событиям 2. настройки мода. И если клацнуть по нпс есть третий пунк Управление симом.

В коментах писали что можно из игровой семьи оставить нужных симов, остальных превратить в нпс не удаляя из семьи. Орава 8+ симов мне не нужна, пусть живут сами по себе, я хочу управлять одним =) Как это сделать? И что дают события в менеджере?

Сегодня, 08:02
грузится по 5-7 секунд, это слишком долго при взаимодействиях.

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

Сегодня, 06:52

Это ведь для отладки. Для игрока они не имеют полезного применения. Т.е мод работает "сам", без необходимости что-то править или куда-то смотреть.

В планах была визуализация характеристик, но скриптами ничего не сделать нормально, так что тюнинговать в xml всё же придётся. А если и делать, то делать хорошо. К этому я пока не готов. Хотел пульнуть в симологию лепестковую диаграмму, но столкнулся с рядом проблем и ограничений. А пихать в пай меню, слишком накладно. И так все кому не лень туда пихают свою отладку, от чего грузится по 5-7 секунд, это слишком долго при взаимодействиях. Т.е условно можно было бы даже через горячую клавишу открывать меню, в котором бы содеражались настройки и отладка для модов, чтобы они не находились в пай-меню. Что-то вроде Mod Settings Menu, но как показывает практика, при наличии готового решения, все всё равно пихают кучу отладки именно в пай, и при каждом тыке, вся эта куча обрабатывается раз за разом, снова и снова.

Не знаю, может имеющийся Mod Settings Menu чем-то не удобен, но в целом, это должно быть чуть ли не обязаловкой, а тех кто пихает отладку в пай, нужно поносить на чём свет стоит. И если за столько времени сколько существует моддинг для симсов, этого не произошло, людей лаги и таймауты вполне устраивают.

Информация выводимая в UI в реалтайме тоже нехило прожорливая, т.е выводить информацию при каждом изменении в 0.005 - это глупость, т.е метрика будет постоянно обновляться и пересчитываться и выводится. Она и так считается и расчитывается для тихой работы, а для вывода должна будет еще и проверяться... вообщем немного накладно выходит. Хотя думаю это можно решить непосредственно во время обработки, а выводить "изменения" при изменении порога, который ощутимо на что-то влияет.

Вот и получается, что "простой вывод в UI" - не такой уж и простой. А пихать в пай, я точно не буду.

Сегодня, 04:19

В апдейтере уже есть, можно тему поднимать.

Сегодня, 03:48

допы нет - киты да

Сегодня, 01:26

Кстати, про Анлокер: как я понял, с появлением в 122 версии маркетплейса новые допы выходить больше не будут?

Сегодня, 01:21

в апдейтере мб и есть, а отдельно нет

Сегодня, 00:47

Fix 0.96c на патреоне

Сегодня, 00:06

Video Store Clerk Career 2.0.0

 

Сегодня, 00:01
Aaros добавил патч 1.212.218.1030 на стим андерграунд https://cs.rin.ru/forum/viewtopic.php?f=41&t=153833
Вчера, 23:53

Действительно. Но есть одно "но"... тема про Апдейтер в САБЖе и вот тут нужно понимать для чего эта утилита и какое отличие: от "бразильской схемы" или с Анлокером.

 

 А если почитать комменты ниже, то становится понятно, что не всем очевидно что: "Операция каждый раз одна и та же..." и далее по тексту. Не все "тыжпрограмисты". И приходиться или не приходиться всякий раз писать одно и тоже, как это сделать и гадать на каком этапе "споткнулся" вопрошающий.

 

Даже возьмем ту ситуацию с leek (без обид), вроде опытный игрок, включая всю активность на момент ухода Анадиуса, но споткнулся на "операции каждый раз одна и таже", пытался установкой допа изменить..... рекламу этого допа в игре.  (вроде ничего я не напутал, по памяти пишу)

Вчера, 23:44

А что вникать-то? Операция каждый раз одна и та же: обновить через EA, скопировать гейм в гейм кракед, скопировать с заменой в эту папку файлы от бразильцев и всё.

Вчера, 23:20

lol

Вчера, 21:01

"Выглядит немного странно"? Купание в реке, море или бассейне — это не то же самое, что душ с мылом, логика базовой игры вполне себе реалистична :D

Вчера, 19:24
Обновлённый список консольных команд

Вот бы это всё через интерфейс сделать...

Вчера, 19:02

Со словами "я фсьо сделал(а) привильна, а ана ниработаит".

Вчера, 17:32

у автора на патреоне 5 карт обновлено под последний патчsurrender

Вчера, 17:26

Жду обновления,опять слтели некоторые карты городов.cry2

Вчера, 17:22

Так неинтересно, лучше потом «здесь» спросить: «А почему?», «А как?» и т. п ;)

Вчера, 17:14

А посидеть, почитать, вникнуть? И только потом качать и раскидывать файлы.

Вчера, 15:30

 

 

 

           >Бразильский сайт<

 

 

 

Вчера, 14:30

Почитайте тему, откройте "Инструкция для ручной установки", далее "Как получить все DLC, если у вас пиратка (для файлов от Бразильского Комьюнити)" и "Отдельные DLC, файлы для РУЧНОЙ УСТАНОВКИ и УСТАНОВКИ Patcherом"  в самом низу ссылки "здесь".

Вчера, 14:00

Популярное за неделю

Команда сайта


Администратор

Редактор, переводчик

Переводчик