TackleBox

Зацепить коробку

Мод меню для WEBFISHING и конфигурация API для разработчиков мод!

Добавляет кнопку «Моды» в главное меню и меню выхода, чтобы просмотреть список модов, загружаемых в настоящее время GDWeave. Если мод не загружается, он будет отделен и помечен Tackle Box, чтобы помочь в обнаружении проблем с установленными модами. Моды, которые поставляются с дополнительными опциями конфигурации, будут показывать кнопку для их настройки, позволяя вам включать / отключать функции мода или изменять поведение мода, не касаясь файла json!

Кроме того, Tackle Box предоставляет сигналы и методы для разработчиков модов, чтобы легче взаимодействовать и реагировать на файлы конфигураций модов, предлагая простой способ для модов показывать немедленные обновления в игре, когда их конфигурации обновляются

Разработчики Mod

Tackle Box может отображать дополнительные метаданные для загруженных модов, таких как его текущая версия, автор и краткое описание. Чтобы включить более богатые метаданные с вашим модом для отображения Tackle Box, добавьте ключ «Metadata» в ваш manifest.json со следующим значением:

{
    "Name": "The name of your mod",
    "Author": "Your name goes here~!",
    "Version": "Your mod's current version formatted as a string",
    "Description": "A brief description of your mod"
}

Пример того, как должен выглядеть ваш манифест, ознакомьтесь с манифестом Tackle Box! (Tackle Box's manifest)

Кроме того, с версии 0.2.0, Tackle Box поставляется с дополнительными утилитами для разработчиков. Чтобы использовать утилиты Tackle Box в вашем коде, добавьте в верхней части сценария следующее:

onready var TackleBox := $"/root/TackleBox"

Чтобы Tackle Box был доступен для вашего мода, убедитесь, что вы включили «TackleBox» в качестве зависимости в манифест вашего мода.json!

Сигналы

сигнал mod config updated(mod id, config) #mod id: String, config: Dictionary

• Выдает сигнал каждый раз, когда конфигурация мода обновляется с помощью методов Tackle Box; это позволяет модам немедленно реагировать на любые изменения, внесенные в файлы конфигураций, а не только читать конфигурации при запуске игры!

Пример:

const MOD_ID = "my mod id"

var config: Dictionary

onready var TackleBox := $"/root/TackleBox"


func _ready() -> void:
    TackleBox.connect("mod_config_updated", self, "_on_config_update")


func _on_config_update(mod_id: String, new_config: Dictionary) -> void:
    if mod_id != MOD_ID: # Check if it's our mod being updated
        return
    
    if config.hash() == new_config.hash(): # Check if the config is different
        return
    
    config = new_config # Set the local config variable to the updated config

    # Update anything that needs updating here!

Методы

get mod manifest (mod id: String) словарь

• Возвращает манифест мода для данного идентификатора мода. Ключи возвращаются в файле snake case

get mod metadata (mod id: Струна) словарь

• Возвращает метаданные мода для данного идентификатора мода. Ключи возвращаются в файле snake case

get mod config (mod id: String) словарь

• Возвращает конфигурацию для данного идентификатора мода.

set_mod_config(mod_id: String, new_config: Dictionary) -> int

• Устанавливает конфигурацию для заданного идентификатора мода и создает новый файл конфигурирования, если он не существует; возвращает код ошибки, если не может написать на конфигурацию

Пример

const MOD_ID = "my mod id"

var config: Dictionary
var default_config: Dictionary = {}

onready var TackleBox := $"/root/TackleBox"


func _ready() -> void:
    _init_config()


func _init_config() -> void:
    var saved_config = TackleBox.get_mod_config(MOD_ID)

    for key in default_config.keys():
        if not saved_config[key]: # If the config property isn't saved...
            saved_config[key] = default_config[key] # Set it to the default
    
    config = saved_config
    TackleBox.set_mod_config(MOD_ID, config) # Save it to a config file!