Table of Contents

Начало работы

Это руководство проведёт вас через основные шаги по созданию мода для OneShot: World Machine Edition с помощью WML.API.

Требования

  • .NET Framework (Желательно 4.6.2)
  • Steam-версия OneShot: World Machine Edition
  • Visual Studio 2022 (рекомендуется) или любой другой редактор кода с поддержкой C#. Обратите внимание, что это руководство сделано только для Visual Studio 2022.

Настройка проекта

  1. Создайте проект типа "Библиотека классов (.NET Framework)":
    Дайте имени вашего проекта уникальный ID. (например, net.referr.samplemod).
    • Это требуется для предотвращения конфликтов между модами.
  2. Добавьте ссылку на WML.API:
    Вам нужно добавить ссылку на WML.API.dll (предоставлено вместе с загрузчиком), чтобы вы могли использовать API в своём моде. В данный момент вы можете сделать это вручную. Также, вам нужно добавить ссылки на OneShotMG.exe и MonoGame.Framework.dll (оба файла лежат в папке с игрой), чтобы вы могли взаимодействовать с самой игрой.
  3. Реализуйте интерфейс IMod:
    Создайте класс и реализуйте интерфейс IMod.
    Пример: 
     using WorldMachineLoader.API.Core;
 using WorldMachineLoader.API.Interfaces;

 namespace net.referr.samplemod
 {
     public class Mod : IMod
     {
         ModContext context;

         public void OnLoad(ModContext context)
         {
             context.Logger.Log("Mod loading!");
         }

         public void OnShutdown()
         {
             context.Logger.Log("Shutting down!");
         }
     }
 }
  4. Создайте mod.json:
    Вам также нужно иметь метаданные вашего мода в файле mod.json.
    Пример: 
    {
    "name": "SampleMod",
    "id": "net.referr.samplemod",
    "description": "This is Sample Mods description!",
    "author": "ref-err",
    "version": "1.0.0",
    "url": "https://github.com/ref-err/WorldMachineLoader",
    "icon": "icon.png",
    "assembly_name": "net.referr.samplemod" // без .dll!
}
  5. Сборка и установка:
    1. Соберите свой проект - у вас получится что-то вроде net.referr.samplemod.dll.
    2. В папке с игрой создайте mods\SampleMod\ и поместите туда:
      • net.referr.samplemod.dll
      • mod.json
      • icon.png (Необязательно)
  6. Запустите игру:
    Запустите WorldMachineLoader.exe и готово!

Следующие шаги

Когда ваш мод загрузится, вы можете изучить: