EcoAPI

EcoAPI is the first Hytale Economy API that will let plugins use economy in servers

60.0 загрузок

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

Библиотека Утилиты

Скачать последнюю версию (4.0 КБ)

Описание

EcoAPI

EcoAPI является стандартизированным интерфейсный слой Системы экономики Hytale.

Он делает не Хранение денег или сами транзакции. Вместо этого он предоставляет набор абстрактных методов и интерфейсов, которые позволяют:

Экономические плагины (Поставщики) для реализации собственной банковской логики (SQL, JSON и др.).
Игровые плагины (Потребители) взаимодействовать с экономикой (магазины, рабочие места и т.д.) без зависимости от конкретного экономического плагина.

Почему EcoAPI?

для разработчиков

Разделение: Напишите свой плагин один раз. Он будет работать с любой Экономический плагин, который реализует EcoAPI.
Стандартизация: использовать единый набор методов (Баланс, Добавить Баланс, Удалить баланс, баланс) независимо от базовой системы.
Гибкость: Переключите систему поддержки экономики без взлома зависимых плагинов.

Для пользователей / владельцев серверов

Совместимость: Позволяет использовать плагин Shop от разработчика A и банковский плагин от разработчика B вместе.
Свобода: Вы не заперты в одном конкретном плагине. Вы можете менять реализации, когда захотите.

Руководство по установке (для пользователей)

Примечание: EcoAPI ничего не делает самостоятельно. Тебе нужно три Для рабочей системы:

EcoAPI (Этот плагин).
Ан Плагин реализации (Плагин, который фактически хранит деньги и «реализует» EcoAPI).
Любой Потребительские плагины (Шопы, наборы, рабочих мест и т.д.

Шаги:

Скачать последнюю версию из выпуски Страница.
Место .джар файл на ваш сервер плагины папка.
Убедитесь, что вы также установили совместимый Поставщик экономики Плагин.

Руководство по интеграции (для разработчиков)

Поскольку EcoAPI еще не размещен на Maven Central, вы должны установить его на свой компьютер. Репозиторий Maven Использовать его как зависимость.

Шаг 1: Установите локально

Скачать последнюю версию из выпуски Страница.
Опубликуйте артефакт в локальный кэш со следующей командой (Maven)

mvn install:install-file -Dfile=Path/To/EcoAPI.jar -DgroupId=com.dunystudios.hytale.plugins -DartifactId=EcoAPI -Dversion=1.0-SNAPSHOT - Упаковка = jar

Шаг 2: Добавить зависимость

Добавьте EcoAPI в свой проект.

<зависимости>
<зависимость>
<groupId>com.dunystudios.hytale.plugins</groupId>
<artifactId>EcoAPI</artifact Id>
<version>1.0-SNAPSHOT</version>
<scope>предоставлено </scope>
</зависимость>
</зависимость>

Шаг 3: Примеры использования

Использование экономики (потребитель) Если вы создаете плагин Shop или Job, используйте API для изменения баланса:

// Получить экономический плагин
Экономика IEcoAPI = IEcoAPI.Service.getInstance();

// Получите баланс игрока
Поплавковый баланс = economy.getBalance(uuid);

// Добавьте 10 баллов игроку
economy.addBalance(uuid, 10);

Удалить 10 балансов у игрока
economy.removeBalance(uuid, 10);

// Настройка 10 баланса для игрока
economy.setBalance(uuid, 10);

Обеспечение экономики (реализатор) Если вы создаете плагин Economy, вы должны реализовать интерфейс и зарегистрировать его.

Основной класс:

 Общественный класс MyEconomyPlugin расширяется Java-плагин {
частный финал Экономика;

Публичный MyEconomyPlugin()
Это.экономика = новая экономика();
?

@Override
Защищенная установка void() {
IEcoAPI.Service.setInstance (экономика);
?

?

Экономический класс:

Общественный класс Экономика реализует IEcoAPI {

@Override
Публичный поплавок getBalance (UUID uuid)
// Ваша логика
возврат 0;
?

@Override
public void addBalance (UUID uuid, float v)
// Ваша логика
?

@Override
Public void removeBalance (UUID uuid, float v)
// Ваша логика
?

@Override
public void setBalance (UUID uuid, float v)
// Ваша логика
?
?

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

EcoAPI 🔗

EcoAPI is a standardized interface layer for Hytale economy systems.

It does not handle money storage or transactions itself. Instead, it provides a set of abstract methods and interfaces that allow:

Economy Plugins (Providers) to implement their own banking logic (SQL, JSON, etc.).
Gameplay Plugins (Consumers) to interact with the economy (shops, jobs, etc.) without depending on a specific economy plugin.

❓ Why EcoAPI?

🛠 For Developers

Decoupling: Write your plugin once. It will work with any economy plugin that implements EcoAPI.
Standardization: Use a unified set of methods (getBalance, addBalance, removeBalance, setBalance) regardless of the underlying system.
Flexibility: Switch the backing economy system without breaking dependent plugins.

🎮 For Users / Server Owners

Compatibility: Allows you to use a Shop plugin from Developer A and a Banking plugin from Developer B together seamlessly.
Freedom: You are not locked into a single specific economy plugin. You can swap implementations whenever you want.

📥 Installation Guide (For Users)

Note: EcoAPI does nothing on its own. You need three things for a working system:

EcoAPI (This plugin).
An Implementation Plugin (A plugin that actually stores the money and "implements" EcoAPI).
Any Consumer Plugins (Shops, Kits, Jobs, etc.).

Steps:

Download the latest release from the Releases page.
Place the .jar file into your server's plugins folder.
Ensure you also install a compatible Economy Provider plugin.

💻 Integration Guide (For Developers)

Since EcoAPI is not yet hosted on Maven Central, you must install it into your local Maven repository to use it as a dependency.

Step 1: Install Locally

Download the latest release from the Releases page.
Publish the artifact to your local cache with the following command (Maven)

mvn install:install-file -Dfile=Path/To/EcoAPI.jar -DgroupId=com.dunystudios.hytale.plugins -DartifactId=EcoAPI -Dversion=1.0-SNAPSHOT -Dpackaging=jar

Step 2: Add Dependency

Add EcoAPI to your project.

<dependencies>
    <dependency>
        <groupId>com.dunystudios.hytale.plugins</groupId>
        <artifactId>EcoAPI</artifactId>
        <version>1.0-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Step 3: Usage Examples

Using the Economy (Consumer) If you are making a Shop or Job plugin, use the API to modify balances:

// Get the economy plugin
IEcoAPI economy = IEcoAPI.Service.getInstance();

// Get the balance of a player
float balance = economy.getBalance(uuid);

// Add 10 of balance to a player
economy.addBalance(uuid, 10);

// Remove 10 of balance from a player
economy.removeBalance(uuid, 10);

// Set 10 of balance to a player
economy.setBalance(uuid, 10);

Providing the Economy (Implementer) If you are making an Economy plugin, you must implement the interface and register it.

Main class:


public class MyEconomyPlugin extends JavaPlugin {
    private final Economy economy;

    public MyEconomyPlugin() {
        this.economy = new Economy();
    }

    @Override
    protected void setup() {
        IEcoAPI.Service.setInstance(economy);
    }

}

Economy class:

public class Economy implements IEcoAPI {

    @Override
    public float getBalance(UUID uuid) {
        // Your logic
        return 0;
    }

    @Override
    public void addBalance(UUID uuid, float v) {
        // Your logic
    }

    @Override
    public void removeBalance(UUID uuid, float v) {
        // Your logic
    }

    @Override
    public void setBalance(UUID uuid, float v) {
        // Your logic
    }
}