TheoTown

TheoTown

Not enough ratings
Как создать свой плагин | TheoTown [RU]
By volshebnik
Подробное объяснение того, как создать свой собственный плагин в TheoTown.
   
Award
Favorite
Favorited
Unfavorite
Создание изображения плагина
Изображение плагина можно нарисовать в программе для рисования, лично я использую Pixel Studio.

Для удобства рисования вы можете нарисовать сетку для основы плагина.















Ваш плагин должен быть расположен в сетке так, чтобы его крайние пиксели наполовину касались каждой ступени пиксельной лестницы.
Вот так















На примере плагина будет понятнее.















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















Если вы хотите сделать плагин с ночной анимацией (например, светом из окон или светящимися баннерами), с зимним видом и все это с механикой вращения, то вам необходимо подготовить подобные изображения.




Вы можете добавить 2 или 4 варианта поворота, поэтому, если вам нужны два, сделайте похожие изображения только с двумя видами дома: обычный вид, анимация и зимний вид.
Создание папки плагина
Для создания папки плагина вам необходимо перейти по ссылке. Plugin creator website[pca.svetikas.lt].
Теперь я объясню каждую настройку на этом сайте. Некоторые настройки можно изменить после создания папки, поэтому их изменение на сайте не имеет значения, так как сейчас важно создать папку с необходимыми файлами. Расскажу в описании настроек, к каким настройкам это относится

  • Идентификатор манифеста
    Не изменяйте.

  • Версия
    Оставить 1.

  • Название
    Название вашего плагина.

  • Описание
    Описание вашего плагина.

  • Автор
    Ваше имя или ник, как хотите.

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

  • Рамки
    Нажмите «Добавить пользовательский кадр» и выберите изображение из своих файлов. Если их несколько, проделайте это столько раз, сколько у вас изображений. Например, если у вас есть обычное изображение, зимнее изображение и ночное анимационное изображение, то вам нужно добавить 2 кадра.

  • Ширина и высота
    Не имеет значения менять.

  • Уровень
    Выберите любой уровень.

  • Необязательные атрибуты
    Если ваш плагин резиденция, коммерция, индустрия, то лучше ничего не выбирать (цену и количество людей игра определит сама). Если это не так, то выберите нужные вам атрибуты. Почему-то список атрибутов плохо прокручивается колесиком мыши, из-за этого могут возникнуть проблемы.

  • Нажмите «Экспортировать как zip-архив»
    Скачается zip-архив. Разархивируйте скачанный zip-архив и откройте разархивированную папку. Он должен содержать изображения для вашего плагина, файл манифеста и файл кода JSON.
Если все в порядке, то поздравляю, вам удалось создать папку плагина.
Редактирование файла манифест
  1. В папке плагина откройте файл манифеста с помощью Блокнота и используйте предоставленный пример, чтобы проверить корректность.
    { "id": "id вашего плагина", "version": 1, "title": "название вашего плагина", "text": "описание вашего плагина", "author": "ваше имя" }

  2. По желанию вы можете добавить встроенный перевод с помощью тега.
    Текст[тег]Перевод
    Например, код с переводом на русский язык.
    { "id": "ID of your plugin", "version": 1, "title": "Earth[ru]Земля", "text": "Planet[ru]Планета", "author": "your name" }
    Подробнее о встроенных переводах можно узнать на сайте Plugin inline translation - TheoTown[forum.theotown.com].

  3. Если вас всё устраивает, вы можете сохранить файл и закрыть его.
Редактирование кода JSON
В папке плагина откройте файл кода JSON с помощью Блокнота. Чтобы избежать путаницы, скопируйте куда-нибудь этот код. Вы можете удалить текст кода, так как вы будете работать с готовыми кодами; ваша задача будет заключаться в копировании, вставке и редактировании вашего плагина. А теперь будет представлен список json-кодов с описанием.

Пример кода JSON для плагина без механики вращения, с анимацией и зимним видом.
[ { "id": "ID вашей анимации", "type": "анимация", «light»: true, «light switching»: true, "frames": [{"bmp": "имя вашей картинки",}], «rotation aware»: false }, { "id": "Идентификатор вашего плагина", "type": "тип вашего плагина", «level»: выберите уровень от 1 до 3, если ваш плагин является жилым, коммерческим или промышленным, "author": "ваше имя", "width": ширина вашего плагина (должна совпадать с высотой), "height": высота вашего плагина (должна совпадать с шириной), "frames": [{"bmp": "имя вашей картинки"}], "frames Winter": [{"bmp": "имя вашей картинки"}], "animation": [{"id": "ID вашей анимации", "x":число,"y":число} ] } ]
Например
[ { "id": "$Volshebnik33_GreenHouse_Night_Light", "type": "animation", "light": true, "light switching": true, "frames": [{"bmp": "nightlight.png",}], "rotation aware": false }, { "id": "$Volshebnik33_GreenHouse", "type": "residential", "level": 2, "author": "Volshebnik33", "width": 2, "height": 2, "frames": [{"bmp": "greenhouse.png"}], "frames winter": [{"bmp": "greenhouse_winter.png"}], "animation": [{"id": "$Volshebnik33_GreenHouse_Night_Light", "x":0,"y":-36}] } ]
Пример кода JSON для плагина с механикой вращения, анимацией и зимним видом.
[ { "id": "ID вашей анимации", "type": "анимация", «light»: true, «light switching»: true, "frames": [ { "bmp": "название вашей картинки", «count»: 2 или 4, "h": высота одного поворота, "w": ширина одного поворота } ], «rotation aware»: true }, { "id": "Идентификатор вашего плагина", "type": "тип вашего плагина", «level»: выберите уровень от 1 до 3, если ваш плагин является резиденцией, коммерцией или индустрией, "author": "ваше имя", «width»: ширина вашего плагина (должна совпадать с высотой), "height": высота вашего плагина (должна совпадать с шириной), "frames": [ { "bmp": "название вашей картинки", «count»: 2 или 4, "h": высота одного оборота, "w": ширина одного оборота } ], "frames winter": [ { "bmp": "название вашей картинки", «count»: 2 или 4, "h": высота одного поворота, "w": ширина одного поворота } ], "animation": [{"id": "[i]ID вашей анимации[/i]", "x":число,"y":число} ] } ]
Например
[ { "id": "$Volshebnik33_GreenHouse_Night_Light", "type": "animation", "light": true, "light switching": true, "frames": [ { "bmp": "nightlight.png", "count": 4, "h": 52, "w": 64 } ], "rotation aware": true }, { "id": "$Volshebnik33_GreenHouse", "type": "residential", "level": 2, "author": "Volshebnik33", "width": 2, "height": 2, "frames": [ { "bmp": "greenhouse.png", "count": 4, "h": 52, "w": 64 } ], "frames winter": [ { "bmp": "greenhouse_winter.png", "count": 4, "h": 52, "w": 64 } ], "animation": [{"id": "$Volshebnik33_GreenHouse_Night_Light", "x":0,"y":-36}] } ]

Если в вашем первом скопированном коде были строки, которых не было в этих кодах, то это должны быть атрибуты, если вы добавили их на сайт. Эти строки нужно добавить в код в одну строку, например в одну строку с типом плагина.
Если вам не нужна анимация или зимний вид, их можно просто убрать из кода, но чтобы не нарушались другие атрибуты, чтобы этого не произошло, вы можете проверить корректность json-кода на сайте JSON Editor Online: edit JSON, query JSON[jsoneditoronline.org].
Если все правильно, то сохраните файл и закройте.
Пояснение к координатам для анимаций
Отсчет координат начинается примерно с крайнего левого пикселя. Почему-то числа на оси «y» расположены в обратном порядке, вверх уменьшается, вниз увеличивается.
Добавление плагина в игру
После проделанных действий у вас должна появиться папка с вашим полноценным плагином.
Есть два способа добавить ваш плагин в TheoTown.

Способ 1. Локальный плагин
Этот метод позволяет добавить ваш плагин в игру как локальный, то есть вы не сможете использовать его в онлайн-игре.
Добавить плагин таким способом очень просто. Просто скопируйте папку плагина и вставьте ее в папку плагинов TheoTown по этому пути.
C:\Users\имя_пользователя\TheoTown\plugins
После этого вам нужно зайти в TheoTown, если игра запустилась, значит ваш плагин работает, если после загрузки вылезает экран с ошибкой, то в json-коде ошибка.
Таким образом, вы можете проверить, соответствует ли изображение анимации изображению плагина и действительно ли плагин работает так, как вы хотите.

Способ 2: Добавление плагина на форум TheoTown
Чтобы добавить плагин на форум, вам необходимо заархивировать ваш плагин в zip-архив. Затем вам нужно перейти на страницу форума TheoTown, чтобы добавить плагин - TheoTown - Plugin Upload[forum.theotown.com]. Для каждой строки будет подробное описание. После настройки нажмите «Submit». Ваш плагин должен быть добавлен. Ваш плагин скоро будет рассмотрен модераторами. Если ваш плагин одобрен, вы можете поискать его в игре :)

Вот и все. Я надеюсь, что это руководство было для вас полезным.
Ссылки, которые могут быть вам полезны