CC Synaxis Connector

CC Synaxis Connector

CC Synaxis Connector — это мод на совместимость с NeoForge для подключения компьютеров CC: Tweaked к портам установок Synaxis Cimulink.

Он добавляет платы-мосты, которые позволяют Lua-программам, схемам Synaxis и процессам логирования в CSV обмениваться значениями без необходимости писать кастомные скрипты с обеих сторон каждого соединения.

Основные возможности

• Подключение периферии CC: Tweaked к портам Synaxis Cimulink.
• Именованные односторонние мостовые сигналы типа real/boolean.
• Плата Super Hub для обёртки соседней периферии CC и значений установок Synaxis.
• Чтение выбранных значений Synaxis из Lua в CC через одну периферию.
• Запись методов периферии CC в стиле getter/setter в порты Synaxis.
• Запись сигналов Synaxis в CSV-файлы с внутриигровым редактором таблиц.
• Поддержка английского и упрощённого китайского текста интерфейса.

Требования

Мод не является самостоятельным. Устанавливайте его вместе с CC: Tweaked, Synaxis и зависимостями, необходимыми для Synaxis.

Проверенная конфигурация:

• Minecraft 1.21.1
• NeoForge 21.1.226+
• CC: Tweaked 1.118.0+
• Synaxis 1.3.4+
• Sable 1.1.3+
• Sable Schematic API 0.2.6+
• LDLib2 2.2.17+
• Create 6.0.10+
• Flywheel 1.0.6+

Собранный jar не включает CC: Tweaked, Synaxis, Sable, Create и их ресурсы. Эти моды нужно получить из официальных каналов распространения.

Блоки

CC: Synaxis Bridge

Bridge — это небольшая плата в стиле Cimulink для вручную создаваемых односторонних сигнальных каналов.

У каждого канала моста есть:

• уникальное имя, например bridge_1
• тип: real или boolean
• направление: cc_to_synaxis или synaxis_to_cc
• необязательная настройка «сохранять последнее значение» для отсутствующего входа Synaxis

Создавайте и удаляйте каналы моста через интерфейс блока. Подключайте созданные порты инструментами проводки Synaxis. Компьютеры CC могут обращаться к блоку как к периферии с именем cc_synaxis_bridge.

CC: Synaxis Super Hub

Super Hub — это плата для обёртки соседних устройств в порты для другой стороны моста.

У неё две страницы интерфейса:

• Providing to Synaxis: выберите обёрнутые возможности CC или Synaxis и предоставьте их как порты Synaxis Cimulink.
• Providing to CC: выберите обёрнутые возможности CC или Synaxis и предоставьте их через периферию CC Super Hub.

Для периферии CC методы в стиле геттеров, такие как getSpeed(), isRunning() или hasFuel(), считаются читаемыми значениями. Методы в стиле сеттеров, такие как setSpeed(value), где возможно, становятся записываемыми входами.

Для Synaxis хаб читает доступные значения установок через доступ в стиле шины/портов установки Synaxis и предоставляет совместимые значения в CC или в порты Synaxis.

Log Output Assistant

Log Output Assistant — это входная плата Synaxis, которая записывает значения сигналов в CSV.

Поддерживается до 10 столбцов. Каждый столбец создаёт один входной порт Synaxis и может быть настроен как real или boolean. Пустые, никогда не активировавшиеся входы записываются как null, если только пустые строки не пропускаются.

Основные настройки:

• имя лога / выходной файл
• id строки: тик, номер строки или нет
• режим записи: каждый тик, при изменении значения или каждые N тиков
• режим создания: сразу, при любом входе или при одном выбранном входе
• пропускать или записывать полностью пустые строки
• импорт существующих CSV-файлов из безопасной папки вывода

CSV-файлы записываются внутри текущего сохранения в:

ccsconnector_outputs/

На серверах выбор файлов намеренно ограничен этой папкой вывода. Клиентский процесс импорта также сканирует только собственную папку ccsconnector_outputs клиента и загружает содержимое выбранного CSV на сервер.

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

1. Разместите одну из плат-коннекторов.
2. Нажмите правой кнопкой мыши по плате с пустой рукой, чтобы открыть интерфейс.
3. Настройте нужные мосты, хаб или столбцы лога.
4. Подключите видимые порты инструментами проводки Synaxis.
5. Присоедините или разместите компьютер CC рядом с блоком, когда нужен доступ из CC.
6. Используйте вызовы периферии в Lua для чтения или записи настроенных значений.

CC Lua API

Периферия Bridge

Тип периферии:

cc_synaxis_bridge

Методы:

list()
schema()
info(name)
addBridge([name], type, direction)
removeBridge(name)
get(name)
set(name, value)
lastWriteTick(name)
getSaveLastValue(name)
setSaveLastValue(name, enabled)
toggleSaveLastValue(name)

Пример:

local bridge = peripheral.find("cc_synaxis_bridge")
assert(bridge, "Bridge not found")

bridge.addBridge("target_speed", "real", "cc_to_synaxis")

local value = 0
while true do
  bridge.set("target_speed", value)
  value = value + 1
  sleep(1)
end

Периферия Super Hub

Тип периферии:

cc_synaxis_super_hub

Методы:

list()
schema()
get(name)
getAll()
refresh()
lastUpdateTick(name)

listSynaxis()
getSynaxis(name)
getAllSynaxis()
synaxisLastUpdateTick(name)

listCcCandidates()
listExposedCc()
getCc(name)
getAllCc()

expose(...)
toggleExpose(...)
set(name, value)
write(name, value)
listProvidedToSynaxis()

Экспозиция настраивается в интерфейсе Super Hub. Lua может читать настроенные значения и записывать в настроенные доступные для записи записи, но она не создаёт строки экспозиции в интерфейсе. Записи expose и toggleExpose — зарезервированные методы совместимости, и они направят игроков настраивать экспозицию в интерфейсе.

Пример:

local hub = peripheral.find("cc_synaxis_super_hub")
assert(hub, "Super Hub not found")

hub.refresh()

for name, value in pairs(hub.getAll()) do
  print(name, value)
end

Примечания и ограничения

• Порты, обращённые к Synaxis, сейчас поддерживают значения real и boolean.
• Текстовые/строковые значения не экспонируются как порты Synaxis, если только Synaxis не предоставляет совместимый тип сигнала.
• Не каждый метод периферии CC можно безопасно вызвать без аргументов. Super Hub сосредоточен на простых методах в стиле геттеров/сеттеров.
• CC и Synaxis могут обновляться с разной скоростью. Блоки-коннекторы кэшируют значения, чтобы любая из сторон могла читать в своём собственном темпе.
• Настраивайте провода Synaxis обычными инструментами Synaxis. Правый клик пустой рукой открывает интерфейсы коннекторов.

Разрешение на модпаки

Вы можете включать CC Synaxis Connector в модпаки при условии, что все необходимые зависимости получены и распространяются в соответствии с их собственными лицензиями и разрешениями.

Лицензия

Этот репозиторий лицензирован под MIT License только для оригинального кода слоя совместимости и ресурсов этого проекта. См. LICENSE.

CC: Tweaked, Synaxis, Sable, LDLib, Create, Flywheel, NeoForge, Minecraft и связанные с ними названия, API, товарные знаки, исходный код, бинарные файлы, модели, текстуры и документация принадлежат их соответствующим владельцам и остаются под их upstream условиями.

CC Synaxis Connector — независимо созданный, AI-assisted мод совместимости. Он не связан с авторами CC: Tweaked, Synaxis, Sable, LDLib, Create, NeoForge, Minecraft или Mojang/Microsoft, не одобрен и не спонсируется ими.

См. THIRD_PARTY_NOTICES.md для заметок о зависимостях и правообладателях.

Заметки по разработке

Большинство зависимостей разрешается из Maven через Gradle. Локальная директория libs/ предназначена только для зависимостей, которые в настоящее время не разрешаются из публичного Maven в этом проекте:

• synaxis-1.3.4.jar
• sable-schematic-api-0.2.6.jar

libs/*.jar игнорируется Git, поэтому jar-файлы зависимостей не следует коммитить.

Резервный вариант совместимости для generic-периферии CC:T изолирован в CcTweakedInternals, чтобы доступ к непубличному CC:T было легко проверить или удалить, если upstream API изменятся.

Доступ к растениям Synaxis идёт через зарегистрированные порты PlantEndpointProvider и PlantPortProviders.tryCreate.