UnboundLib

Присоединяйтесь!

Для большего количества модов, новостей и поддержки присоединяйтесь к нам по раздору здесь: https://discord.gg/mGfsTvc53v

UnboundLib

Это полезная утилита для моддеров ROUNDS, направленных на упрощение определенных общих задач.

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

Сетевой менеджер

NetworkingManager абстрагирует сетевые возможности Photon по умолчанию в простой в использовании интерфейс, который вы можете использовать для связи между клиентами. Пример использования:

private const string MessageEvent = "YourMod_MessageEvent";

NetworkingManager.RegisterEvent(MessageEvent, (data) =>
{
	ModLoader.BuildInfoPopup("Test Event Message: " + (string)data[0]);    // should print "Test Event Message: Hello World!"
});

// send event to other clients only
NetworkingManager.RaiseEventOthers(MessageEvent, "Hello World!");

// send event to other clients AND yourself
NetworkingManager.RaiseEvent(MessageEvent, "Hello World!");

CustomCard Framework

Создайте класс для вашей карты, расширьте класс CustomCard, реализуйте его методы, а затем в вашей инициализации мода зарегистрируйте свою карту так:

void Start()
{
    CustomCard.BuildCard();
}

CustomMap Framework

Сначала создайте карту в единстве, используя пакет и экспортируйте свою сцену в AssetBundle. Затем в вашей инициализации мода зарегистрируйте свою карту так:

void Start()
{
    LevelManager.RegisterLevels(TestAssetBundle);
}

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

Регистрация кредитов для мода так же проста, как:

void Start()
{
    Unbound.RegisterCredits(string modName, string[] credits, string linkText, string linkURL);
}

GameMode Framework

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

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

Крюки

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

Крючок для триггеров

Режимы игры могут запускать асинхронные крючки, когда они хотят:

private IEnumerator RoundStart()
{
	// Hook keys are case-insensitive
	yield return GameModeManager.TriggerHook("RoundStart");

	// A healthy set of predefined keys is provided to make hooking on to them easier.
	// Predefined keys should be used in favour of custom ones when possible.
	yield return GameModeManager.TriggerHook(GameModeHooks.HookRoundStart);
}

Регистрация крючков

Моды могут регистрировать слушателей, где они хотят:

private void Init()
{
	// Hooks are called with the game mode that triggered the hook, which is always the currently active game mode
	GameModeManager.AddHook(GameModeHooks.HookRoundStart, this.OnRoundStart);
}

private IEnumerator OnRoundStart(IGameModeHandler gm)
{
	// Triggers are IEnumerators so they support yields
	yield return new WaitForSeconds(2f);

	UnityEngine.Debug.Log(gm.Name);

	/* Since triggers are IEnumerators, they must be executed within a coroutine. This means triggers are guaranteed to
	 * be able to disrupt the execution of the current game mode.
	 */
	gm.GameMode.StopAllCoroutines();
}

Существующие игровые режимы в ROUNDS, а именно Arms Race и Sandbox, также были исправлены для запуска крючков.

Настройки

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

Использование настроек в игровом режиме

private void CheckPoints()
{
	if (p1Points >= (int)GameModeManager.CurrentHandler.Settings["pointsToWinRound"])
	{
		WinRound();
	}
}

Изменение параметров (в моде)

private void Init()
{
	GameModeManager.AddHook(GameModeHooks.HookInitEnd, this.OnInitEnd);
}

private IEnumerator OnInitEnd(GameModeHandler gm)
{
	gm.ChangeSetting("pointsToWinRound", 10);
}

См. /UnboundLib/GameModes для деталей реализации и примера GameModeHandlers.

Развитие

Строительство проекта, скорее всего, будет работать без необходимости что-либо менять. Однако, если ваша установка ROUNDS находится в другом месте, чем C:\Program Files (x86)\Steam\steamapps\common\ROUNDS, вам нужно будет изменить путь, который мы предварительно настроили для вас:

1. Скопировать UnboundLib/UnboundLib.csproj.user.dist в UnboundLib/UnboundLib.csproj.user
2. Измените путь установки папки ROUNDS внутри UnboundLib/UnboundLib.csproj.user

Теперь вы можете открыть проектное решение с помощью Visual Studio.