HyVoltz

An electricity API for generation, transmission, and storage; in hopes of having a unified library.

21.0 загрузок

Обновлён 9 дней назад

Библиотека Утилиты Разное

Описание

Вольц

HyVoltz - это легкий электрический API для модов Hytale. API называется HyVoltz; единица энергии, которую он обрабатывает, называется HyVoltz. вольт. Все утилиты хранения, передачи и бокового IO работают в вольтце.

Особенности

Интерфейсы хранения и передачи Voltz
Боковая конфигурация IO на лицо блока
Помощники по симуляции передачи
Простые эталонные реализации для быстрой интеграции

Обзор API

Пакет: com.siriuswolf.hyvoltz.api.power

Основные типы (store/transfer) вольт):

PowerConsumer (получает)
поставщик электроэнергии (выдержка)
Хранение энергии (оба + вместимость)

Сбоку:

PowerSide Карты для Hytale Блокфейс
PowerConnection Ни один / INPUT / OUTPUT / Оба
SidedPowerДоступ / MutableSidedPowerДоступ для конфигурирования по бокам
Потребитель SidedPower, SidedPower поставщик, SidedPower Хранение для бокового IO

Справочные реализации:

SimplePowerStorage Ограниченная пропускная способность и IO
SidedPowerConfig для состояния персайдной связи
SidedPowerStorageImpl Комбинации для простого использования

Помощники:

PowerTransfer Безопасный трансфер с поддержкой симуляции

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

Создайте простое хранилище в конденсаторном стиле (10 000 вольт):

Импорт com.iriuswolf.hyvoltz.api.power.

BasicCapacitor расширяет SidedPowerStorage Impl { public BasicCapacitor() { super(10_000, 200, 200, новый SidedPowerConfig(PowerConnection.BOTH)); } }

Передача вольт между двумя хранилищами:

int moved = PowerTransfer.transfer (источник, PowerSide.EAST, цель, PowerSide). Запад, 100, ложный.

Совет: Я действительно предпочитаю Shadowjar смотреть на него для сборки!

Серверный API зависимость

Проект нацелен на новейший серверный API Hytale. Обновить путь серверной банки в build.gradle.kts Если ваша установка отличается:

...game/latest/Server/HytaleServer.jar

Интеграционные ноты

Добавьте HyVoltz к классу вашего мода и обратитесь к API от com.siriuswolf.hyvoltz.api.power.
Если ваш мод загружается вместе с HyVoltz в качестве отдельного плагина, объявите его зависимостью в своем манифесте.

Лицензия

Apache 2.0. https://www.apache.org/licenses/LICENSE-2.0
(Это просто означает, что вы не можете продать его и требует атрибуции, пожалуйста, не называйте его своим.) Но делайте с ним все, что хотите, сходите с ума и делайте классные вещи!

Показать оригинальное описание (English)

HyVoltz

HyVoltz is a lightweight electricity API for Hytale mods. The API is called HyVoltz; the unit of energy it handles is called voltz. All storage, transfer, and sided-IO utilities work in voltz.

Features

Voltz storage and transfer interfaces
Sided IO configuration per block face
Simulation-aware transfer helpers
Simple reference implementations for quick integration

API Overview

Package: com.siriuswolf.hyvoltz.api.power

Core types (store/transfer voltz):

PowerConsumer (receive)
PowerProvider (extract)
PowerStorage (both + capacity)

Sided IO:

PowerSide maps to Hytale BlockFace
PowerConnection defines NONE / INPUT / OUTPUT / BOTH
SidedPowerAccess / MutableSidedPowerAccess for per-side config
SidedPowerConsumer, SidedPowerProvider, SidedPowerStorage for side-gated IO

Reference implementations:

SimplePowerStorage for capacity and rate-limited IO
SidedPowerConfig for per-side connection state
SidedPowerStorageImpl combines both for easy use

Helpers:

PowerTransfer for safe transfer with simulation support

Basic Usage

Create a simple capacitor-style storage (10,000 voltz):

import com.siriuswolf.hyvoltz.api.power.*;

public final class BasicCapacitor extends SidedPowerStorageImpl { public BasicCapacitor() { super(10_000, 200, 200, new SidedPowerConfig(PowerConnection.BOTH)); } }

Transfer voltz between two storages:

int moved = PowerTransfer.transfer(source, PowerSide.EAST, target, PowerSide.WEST, 100, false);

Tip: I really prefer shadowjar look into it for builds!

Server API Dependency

The project targets the Hytale latest server API. Update the server jar path in build.gradle.kts if your install differs:

...game/latest/Server/HytaleServer.jar

Integration Notes

Add HyVoltz to your mod's classpath and reference the API from com.siriuswolf.hyvoltz.api.power.
If your mod loads alongside HyVoltz as a separate plugin, declare it as a dependency in your manifest.

License

Apache 2.0. See https://www.apache.org/licenses/LICENSE-2.0
(This just means you can't sell it, and requires attribution, please don't call it your own. But make whatever the heck you want with it, go crazy and make cool stuff!)