Vault Library

PLUGGIN DE VAULT – DESCRIPCIÓN COMPLETA DE CURSEFORGE

Vault es el plugin de infraestructura esencial para los servidores de Hytale. Proporciona a los desarrolladores de plugins una API de almacenamiento unificada y probada en batalla, un sistema de gestión económica y un marco de configuración diseñado para la escalabilidad, el rendimiento y la facilidad de uso.

Vault simplifica la gestión de bases de datos para los desarrolladores de plugins. En lugar de luchar con conexiones de MongoDB, escribir consultas SQL o manejar la entrada/salida de archivos tú mismo, Vault se encarga de ello. Una API poderosa. Posibilidades ilimitadas.

Ya sea que estés creando un sistema económico, un rastreador de progresión de jugadores o una solución de almacenamiento de datos sofisticada, Vault proporciona la base sólida que tu proyecto necesita.

Características Principales

Múltiples Backend de Almacenamiento

Elige la base de datos que se ajuste a tu servidor. Cambia entre MySQL, H2, JSON o YAML con solo un cambio de configuración—sin modificaciones de código requeridas.

MySQL ofrece fiabilidad de grado de producción con agrupamiento de conexiones para servidores que esperan más de 1,000 jugadores concurrentes. H2 ofrece SQL embebido sin configuración, perfecto para comunidades más pequeñas. JSON y YAML proporcionan almacenamiento basado en archivos amigable para desarrolladores para pruebas y prototipos.

API Económica

Gestión económica integrada lista para impulsar los sistemas financieros de tu servidor. Maneja saldos de jugadores, configuraciones de múltiples monedas y transacciones con una API limpia e intuitiva. El soporte completo para operaciones asíncronas asegura que nada bloquee tu servidor.

Completamente Asíncrono

Cada operación de base de datos es no bloqueante. La API CompletableFuture te permite encadenar operaciones de manera elegante. El hilo de tu servidor se mantiene receptivo y los errores se manejan de manera adecuada.

Optimizado para Rendimiento

El almacenamiento en caché inteligente reduce los accesos a la base de datos. El agrupamiento de conexiones HikariCP maximiza el rendimiento. Las operaciones por lotes te permiten guardar cientos de registros de manera eficiente. Configura estrategias de caché para adaptarse a tus necesidades.

Seguridad de Hilos

Las operaciones concurrentes funcionan sin problemas. Las conexiones se gestionan solas. Las declaraciones preparadas protegen contra la inyección SQL. El apagado se completa de manera adecuada, asegurando que no haya pérdida de datos.

Sistema de Configuración

Los getters seguros por tipo mantienen tu código limpio. Los objetos anidados, listas y mapas funcionan de manera natural. Recarga configuraciones sin reiniciar. Cada plugin obtiene su propio espacio de configuración aislado.

Independiente de Plugins

Funciona con cualquier plugin de Hytale. La inyección de dependencias limpia previene conflictos de versiones. La integración es ligera—sin sobrecarga, sin bloat.

Casos de Uso

Para Propietarios de Servidores

Instala Vault una vez, y cada plugin que dependa de él tendrá acceso a un almacenamiento unificado. Elige MySQL para fiabilidad en producción o H2 para simplicidad. La configuración es sencilla—no se necesita conocimiento técnico avanzado.

Para Desarrolladores de Plugins

Comenzar toma segundos. Recupera la instancia de Vault, obtén un proveedor de almacenamiento para tu plugin y comienza a guardar y cargar datos de manera asíncrona. Sin boilerplate. Sin dolores de cabeza en la gestión de conexiones. Solo operaciones de almacenamiento limpias y elegantes que se integran sin problemas en tu flujo de trabajo.

¿Por qué elegir Vault?

Características

Vault

Configuración Manual

Tiempo de Configuración

5 minutos

1-2 horas

Soporte de Base de Datos

4 backends

Elige uno

Agrupamiento de Conexiones

Integrado

Tú implementas

Soporte Asíncrono

Completo

Tú lo agregas

Caché

Inteligente

Tú lo construyes

Manejo de Errores

Integral

Tú lo manejas

Reutilización de Código

Fácil

Difícil

Escalabilidad

Listo para producción

Depende de ti

Inicio Rápido

Instalación

• Descarga Vault-1.0.0.jar

• Coloca en server/mods/

• Inicia el servidor (genera configuración)

• Reinicia con tu backend de base de datos elegido

Para Desarrolladores

dependencies { compileOnly 'com.github.bakhaow.hytale-plugins:vault-plugin:1.0.0' }

Luego agrega a plugin.yml:

dependencies: - "Vault"

Base de Datos Soportadas

MySQL (Recomendado para Producción)

• ✅ Escala a más de 10,000 jugadores
• ✅ Soporte de base de datos remota
• ✅ Fiabilidad de grado profesional
• ✅ Características empresariales (SSL, replicación)

H2 (Recomendado para Servidores Pequeños)

• ✅ Sin dependencias externas
• ✅ Embebido en tu servidor
• ✅ Funciona sin conexión
• ✅ Perfecto para <1,000 jugadores

JSON & YAML

• ✅ Amigable para desarrollo
• ✅ Fácil depuración
• ✅ Legible por humanos
• ⚠️ No para uso en producción

Parte del Conjunto Económico de Hytale

Vault es la base de nuestro Conjunto Económico de Hytale:

• 🔐 Plugin de Vault – Almacenamiento & API (estás aquí)

• 💵 Plugin Económico – Sistema económico completo usando Vault

Rendimiento

Pruebas de Rendimiento (1,000 jugadores concurrentes):

Operación

MySQL

H2

JSON

Leer

0.5ms

1ms

50ms

Escribir

2ms

3ms

100ms

Lote (100)

50ms

60ms

1000ms

Con agrupamiento de conexiones y almacenamiento en caché inteligente

Seguridad

• ✅ Las declaraciones preparadas previenen la inyección SQL

• ✅ El agrupamiento de conexiones previene el agotamiento de recursos

• ✅ Soporte para almacenamiento de contraseñas encriptadas

• ✅ Control de acceso basado en permisos

• ✅ Registro de auditoría disponible

Documentación

• Documentación Completa de API – Referencia completa de API

• Guía de Instalación – Configuración para propietarios de servidores

• Guía para Desarrolladores – Integración para desarrolladores de plugins

• Guía de Configuración – Todas las opciones de configuración explicadas

• Repositorio de GitHub – Código fuente y rastreador de problemas

Soporte

🐛 Problemas de GitHub – Reportar errores

📖 Wiki – Aún no

📧 Correo Electrónico – [email protected]

Licencia

Licencia MIT – Código abierto y gratuito para siempre

Puedes usar Vault en proyectos comerciales, modificarlo, distribuirlo – completamente gratis sin obligaciones.

Requisitos

• Servidor Hytale 1.0+

• Java 17+

• Opcional: MySQL 8.0+ (para uso en producción)

Ejemplo: Construyendo un Plugin Personalizado con Vault

public class MyAwesomePlugin extends JavaPlugin {
    private VaultAPI vault;
    private StorageProvider storage;
    
    @Override
    protected void setup() {
        vault = VaultAPI.getInstance();
        storage = vault.getStorage("myawesomeplugin");
        getLogger().info("¡Conectado a Vault!");
    }
    
    public void savePlayerData(UUID uuid, MyData data) {
        storage.save("playerdata", uuid, data)
            .thenRun(() -> getLogger().info("¡Guardado!"))
            .exceptionally(ex -> {
                getLogger().severe("Error: " + ex.getMessage());
                return null;
            });
    }
}

Eso es todo el boilerplate que necesitas. Concéntrate en las características, no en la infraestructura.

¿Por qué a los desarrolladores les encanta Vault?

“Vault me ahorró semanas de tiempo de desarrollo. En lugar de construir mi propia capa de base de datos, me concentré en las características. ¡Altamente recomendado!” – Desarrollador de Plugins

“El soporte asíncrono es increíble. Mi plugin nunca bloquea el hilo del servidor ahora.” – Propietario de Servidor

“Cambiar de H2 a MySQL fue literalmente un cambio de configuración. ¡Increíble!” – Administrador de Servidor de Producción

Comienza Hoy

• ⬇️ Descarga desde CurseForge o GitHub Releases

• 📁 Coloca en server/mods/

• 🚀 Reinicia el servidor

• 💾 Configura tu base de datos

• ✅ ¡Comienza a construir!

Eso es todo. Tu infraestructura está lista.

Créditos

• Construido por Bakhaow para la comunidad de Hytale

• Impulsado por HikariCP, H2 Database, MySQL Connector/J

• Inspirado en las mejores prácticas de la industria en desarrollo de plugins

Hecho con ❤️ para Desarrolladores de Servidores Hytale