00-Argonath-Wiki

Argonath Systems Wiki

Welcome to the comprehensive documentation for the Argonath Systems framework ecosystem - a modular architecture for creating rich, quest-driven experiences in Hytale.

Lord of the Rings Themed Server - Building immersive Middle-earth experiences with platform-agnostic, extensible frameworks.

📚 Documentation Structure

🚀 Getting Started

Introduction — Overview of the Argonath ecosystem
Quick Start — Get up and running in 5 minutes
Installation Guide — Detailed setup instructions
Your First Quest — Create your first quest mod
Bundles vs Modules — Choose your development approach

🏛️ Architecture

System Overview — High-level architecture design
Module Reference — Complete module documentation
Core Concepts — Key concepts and terminology
Dependencies — Module dependencies and graphs

📖 Guides

Quest & Objective System

Quest Development — Complete quest creation guide with objectives, conditions, and rewards
First Dungeon — Step-by-step dungeon creation tutorial

NPC & Dialogue System

NPC Integration — Working with NPCs, behaviors, and spawning
NPC Tutorials — Step-by-step NPC creation tutorials
Dialogue System — Complete dialogue tree, conditions, and quest integration
Multi-Dimensional NPC Narrative — AI-driven dynamic NPC storytelling

Combat System

Combat Framework Usage — Implementing combat mechanics
Combat Framework Migration — Migrating from legacy combat systems

UI Development

UI Development — Creating custom UIs with HyUI/HYUIML

Platform & Integration

Hytale Adapter Integration — Accessor Pattern, event translation, and Hytale communication
Configuration — Configuration system guide
Storage & Persistence — Data persistence management

📘 API Reference

Core APIs

Platform Core — Core platform utilities and abstractions
Event System — Event handling, dispatching, and listeners

Framework APIs

Quest Framework — Complete quest system APIs
NPC Framework — NPC, dialogue, and behavior APIs
UI Framework — User interface framework APIs
Combat Framework — Combat system APIs

World & Generation APIs

World Generation — Procedural world generation APIs
Dungeon Generation — Dungeon layout and spawning APIs

Legacy API Reference

NPC Framework (Legacy) — Original NPC framework documentation

🔗 Integration

Module Integration — Combining multiple frameworks

🔬 Advanced Topics

Custom Conditions — Creating custom condition types
Custom Objectives — Implementing custom objectives
Performance Optimization — Best practices and tuning
Testing Strategies — Unit, integration, and E2E testing

🔄 Migration & Upgrade

Migration Overview — Migrating from legacy systems
Upgrading Versions — Version upgrade procedures
Breaking Changes — Complete changelog

🤝 Contributing

Contributing Guide — How to contribute to the project

🏗️ Module Overview

The Argonath Systems architecture follows a layered approach with strict separation of concerns. Business logic remains platform-agnostic through the Accessor Pattern.

Platform Layer (01-xx)

platform-core — Foundation utilities, abstractions, and DataValue type system
platform-sdk — Development kit for extending the platform

Adapter Layer (02-adapter-xx)

adapter-hytale — Hytale game integration (ONLY place for hytale.* imports)
adapter-mod-api — Generic mod API bridge

Core Framework Layer (02-framework-xx)

framework-accessor — Data access patterns and accessor interfaces
framework-core — Core framework services and utilities

Service Framework Layer (03-framework-xx)

framework-config — Configuration management and YAML support
framework-storage — Data persistence and storage backends
framework-text-styling — Text formatting, colors, and styling
framework-webserver — Embedded web server for tools integration

Feature Framework Layer (04-framework-xx)

framework-condition — Condition evaluation system
framework-currency — In-game currency management
framework-npc — NPC management, dialogue, and behaviors
framework-objective — Quest objective tracking system
framework-stats — Player statistics and progression
framework-worldgen — Procedural world generation

High-Level Framework Layer (05-framework-xx)

framework-quest — Complete quest system with lifecycle management
framework-ui — User interface framework (HyUI/HYUIML integration)

Mod Layer (06-mod-xx)

mod-character-races — Character race system for Middle-earth
mod-combat — Combat mechanics and damage system
mod-dungeons-raids — Dungeon and raid content
mod-guilds — Player guild system
mod-housing — Player housing system
mod-loot-tables — Loot table definitions
mod-mounts — Mount system
mod-quest-tracker — Quest tracking UI mod

Tool Layer (07-tools-xx)

tools-prefab-designer — Visual prefab creation tool
tools-quest-designer — Visual quest creation tool (HyQuest)

Library Layer (08-lib-xx)

lib-hyquest-api-client — API client for HyQuest web service
lib-prefab-api-client — API client for Prefab service

Bundles

bundle-core — Core functionality bundle
bundle-quest — Complete quest system bundle (includes core)

🎯 Key Concepts

Accessor Pattern

All business logic (Frameworks, Mods) is platform-agnostic. Hytale API usage is isolated to the adapter layer. See Hytale Adapter Integration for details.

┌─────────────────────────────────────────────────────────────┐
│  Mod Layer (06-xx)         │ Uses only Framework APIs      │
├─────────────────────────────────────────────────────────────┤
│  Framework Layer (02-05)   │ Platform-agnostic logic       │
├─────────────────────────────────────────────────────────────┤
│  Adapter Layer (02-adapter)│ Translates to/from Hytale API │
├─────────────────────────────────────────────────────────────┤
│  Hytale Game Engine        │ Native game code              │
└─────────────────────────────────────────────────────────────┘

DataValue Type System (v2.0.0)

Type-safe data handling using sealed interfaces instead of raw Object types. Used throughout conditions, objectives, and configuration.

🚀 Quick Links

Main Repository — GitHub
Issue Tracker — Report bugs
Discussions — Ask questions
Discord Community — Join our community
Hytale Modding Docs — Official Hytale modding documentation

📦 Bundles vs Individual Modules

New to Argonath? Start with bundles:

bundle-core - Everything needed for basic mod development
bundle-quest - Complete quest system (includes core)

Experienced developer? Pick individual modules for fine-grained control.

See Bundles vs Modules Guide for details.

📄 License

This documentation is licensed under CC BY 4.0.
Code examples are licensed under the same license as the main project.

🤝 Support

📖 FAQ — Common questions and answers
💬 Discussions — Ask questions
🐛 Issues — Report bugs
💡 Ideas — Suggest features

Latest Update: January 2025

Version: 2.0.0

This site is open source. Improve this page.