Investycoon Core SDK

Обзор

InvestycoonCore позволяет настраивать типы компаний, предметы и их характеристики, а также технологии. Пакет требует .NET 10 без дополнительных зависимостей NuGet.

• Пользовательские типы компаний
• Пользовательские предметы и характеристики
• Расширяемые технологии

Установка

Для начала создайте .NET-решение и подключите InvestycoonCore через NuGet:

nuget install InvestycoonCore -Source "GitLab"

Или скачайте файл .nupkg из официального реестра.

Минимальный пример класса Plugin:

public class CustomPlugin : Plugin
{
    public override string Code => "custom-plugin";
    public override string Version => "1.0";
    public override string Name => "Custom Plugin";
    public override string Explanation => "This is a custom plugin";
    public override ResourceManager MainResourceManager => new CustomResourceManager();
}

Класс предоставляет свойства Code, Version, Name, Explanation и MainResourceManager для настройки.

Справочник по членам

Абстрактный класс Plugin предоставляет следующие члены. Code, Name, Version, Explanation и MainResourceManager обязательны. Остальные — опциональны и возвращают false или пустой список по умолчанию.

Полный пример плагина:

public sealed class MyPlugin : Plugin
{
    public override string Code        => "my-plugin";
    public override string Version     => "1.0";
    public override string Name        => "My Plugin";
    public override string Explanation => "Plugin description.";
    public override ResourceManager MainResourceManager
        => Resources.Resources.ResourceManager;

    public override bool ItemIgnoreVanilla        => true;
    public override bool CompanyTypeIgnoreVanilla => true;

    public override List<Item> Items() =>
    [
        new ItemResource(1, "lithium", 20_00).SetMass(25f).SetItemGroup("resource"),
        new Item(2, "battery", 2, 10_00).SetMass(0.1f).SetItemGroup("refined"),
    ];

    public override List<CompanyType> CompanyTypes() =>
    [
        new(1, "tech-company",
            nameof(Resources.Resources.TechCompany_Label),
            nameof(Resources.Resources.TechCompany_Label))
    ];

    public override List<ItemSpecificationType> ItemSpecificationTypes() =>
    [
        new(1, "quality", ItemSpecificationTypeEnum.Quality, [10])
    ];
}

Типы предметов

Выберите тип, соответствующий природе вашего предмета:

new Item(id: 1, name: "battery", tier: 2, defaultPrice: 10_00)
    .SetMass(0.1f)
    .SetVolume(0.0001f)
    .SetItemGroup("refined");

new ItemResource(id: 1, name: "lithium", price: 20_00)
    .SetMass(25f)
    .SetRarity(ItemRarity.GetByName("ordinary")!);

new ItemFuel(id: 1, code: "atomic-battery", price: 300_00)
    .SetEnergy(1_000)
    .SetMass(1f);

new ItemNonPhysical(id: 1, code: "program", price: 0);

new MachineTransformer(id: 1, code: "factory", price: 10_000_00)
    .SetNbInput(2)
    .SetNbOutput(1)
    .SetDelayBuild(TimeSpan.FromHours(1))
    .SetMaxWorkers(3)
    .AddRecipe(new MachineRecipeFuel(
        "my-recipe", "company-type-code",
        inputCapacity: 64, outputCapacity: 12,
        inputs:  [new RecipeProduct("lithium", 2)],
        outputs: [new RecipeProduct("battery", 10)]
    ));

Локализация

Метки в игре (названия предметов, типы компаний, рецепты) переводятся через файлы .resx. Создайте Resources/Resources.resx (English по умолчанию) и Resources/Resources.fr.resx (French).

Настройте ваш .csproj для генерации статического класса-аксессора:

<ItemGroup>
  <EmbeddedResource Update="Resources\Resources.resx">
    <Generator>ResXFileCodeGenerator</Generator>
    <LastGenOutput>Resources.Designer.cs</LastGenOutput>
  </EmbeddedResource>
</ItemGroup>

Затем используйте ResourceManager в вашем плагине:

public override ResourceManager MainResourceManager => Resources.Resources.ResourceManager;

Развёртывание плагина в InvestycoonSky

После компиляции плагина администратор сервера выполняет импорт и активацию из InvestycoonSky. Вам не нужно управлять какой-либо инфраструктурой.

1. Соберите ваш плагин в конфигурации Release и отправьте файл .dll администратору сервера:

dotnet publish -c Release

2. Администратор импортирует .dll через InvestycoonSky и может включать или отключать плагин в любое время без перезапуска сервера.

Плагин появляется в InvestycoonSky с его именем, кодом и версией сразу после импорта. Активация и деактивация полностью управляются из интерфейса администратора.

Иллюстрации

Каждый предмет и тип компании может быть связан с изображением PNG, встроенным непосредственно в сборку плагина.

Разместите изображения в следующих папках внутри вашего проекта плагина:

Resources/
└── Images/
    ├── Items/
    │   ├── lithium.png
    │   └── battery.png
    └── CompanyTypes/
        └── tech-company.png

Объявите их как встроенные ресурсы в вашем .csproj:

<ItemGroup>
  <EmbeddedResource Include="Resources\Images\**\*" />
</ItemGroup>

Имя файла должно точно совпадать со свойством Name предмета или типа компании (с учётом регистра). При запуске AssertValidItem() выбрасывает ResourceCompilingException, если изображение отсутствует.

Лицензия

Распространяется под лицензией LGPL v3+.

Авторы

Разработано Аланом Бретелем.