DOCSEARCHbyAlgolia
Submit Docs

HytaleModding Documentation

repository·main·Indexed 42 days ago

https://github.com/hytalemodding/site

A community-driven platform providing guides and technical documentation for Hytale modders. Covers server-side Java modding, data-driven configuration for NPCs and items, the QUIC network protocol, and the use of Blockbench for .blockymodel assets. Details the server-centric modding model, where the C# client is not moddable and all features, including UI and visuals, are managed via the server API.

Tokens
296.5K
Snippets
520
Records
1.1K
Agent score
54%

What's inside HytaleModding

  1. Overview of the Hyperions Energy API

    main

    Hyperions is a community-maintained API library for Hytale designed to facilitate the storage, transmission, and reception of energy between different mods. It is built upon the Transfer API and is inspired by the TechReborn Energy API.

    Energy Units

    • Energy Unit: The standard unit is the Hyperion (Hy).
    • Transfer Rate: The standard unit for transfer rates is Hyperions per tick (Hy/t). To convert to Hyperions per second (Hy/s), divide the Hy/t value by 30.

  2. Overview of Orbitech features

    main

    Orbitech is a magic-technology mod for Hytale designed to introduce immersive automation systems. Key features include:

    • Kinetic systems and machinery: Rotational-based powered machines and systems inspired by the Create mod, allowing for physical connection-based building.
    • Power system: A copper-wired energy system that allows players to power machines directly.
    • Item management: Automation tools such as chutes, conveyor belts, and NPCs for managing items.
    • Magic energy integration: Utilizing the world's magic as a power source for various machines and utilities.
    • Golem NPCs: Programmable NPCs with customizable behavior and task management for workflows or roleplay.
    • Magical utilities: Various multi-purpose magical devices and utilities.

  4. Overview of Transfer API

    main

    TransferAPI is a community-made API designed to provide a common interface for resource storage and transfer in Minecraft mods. It is built to be flexible and extensible, enabling developers to create custom resource types and storage systems that remain compatible with other mods utilizing the TransferAPI.

    The project aims to provide a generalized implementation of the original Fabric TransferAPI concepts, making it adaptable to various platforms and use cases. Hytale-specific implementations and examples are planned for future release.

  5. Overview of NPC Meta components

    main

    The NPC Meta documentation provides a comprehensive reference for creating and configuring Non-Player Characters (NPCs). The system is organized into several functional categories that allow developers to define NPC behavior, appearance, and interaction:

    • Builders: Tools for constructing NPC definitions.
    • Roles: Definitions of the NPC's functional role (Abstract, Generic, or Variant).
    • Motion Controllers: Logic for movement types like Dive, Fly, and Walk.
    • Misc Parts: A wide array of utility components including ActionList, Aim, Path, Sequence, and StateTransition logic.
    • Core Components: Specialized modules grouped by domain:
      • AudioVisual: Managing animations, appearance, sounds, and particles.
      • Combat: Handling attacks, damage, and entity effects.
      • CoreComponents: Advanced logic for flocking, combat memory, and spawning.
      • Debug: Logging and testing tools.
      • Entity: Sensors and actions related to players, mobs, and targets.
      • Interaction: Managing how NPCs interact with the world and players.
      • Items: Inventory management and item dropping/picking.
      • Lifecycle: Controlling spawning, despawning, and death.
      • Message: Communication via beacons and notifications.
      • Movement: Controlling crouching, altitude, and navigation.
      • NPC: High-level NPC tasks like opening shops or mounting.
      • Path: Pathfinding and navigation sensors.
      • StateMachine: Managing NPC states and transitions.
      • Timer: Controlling temporal logic and alarms.
      • Utility: Logical operators (And, Or, Not), randomizers, and flag management.
      • World: Interacting with blocks, water, light, and weather.

  6. Overview of the Hylamity mod

    main

    Hylamity is a community-maintained mod that brings content from Terraria and the Calamity Mod into Hytale. The project focuses on recreating items and mobs using 3D models that match the Hytale aesthetic while ensuring content fits the Hytale world design.

    Key features include:

    • Unique Identities: Weapons are designed to be unique rather than direct copies.
    • Vanilla Compatibility: Items are balanced with Hytale Vanilla content to allow for smoother mod compatibility.
    • Expanded Content: Includes content from other mods like Fargo's Souls.
    • Redesigned Content: Some elements are redesigned to be unique to the Hytale environment.

  7. Arcio planned features and extensibility

    main

    Future updates for Arcio include:

    • Leylight Transport: A scalable, mana-costed item network featuring Arc Funnels, Chromatic Emitters, Focal Arrays, and Arc Depots.
    • Circuit Boards: Nestable, placeable circuits that support export/import and community share codes.
    • Modder API: A dedicated API providing hooks for other mod authors to extend Arcio's mana and logic primitives.

  9. Styling options for HytaleModding wiki pages

    main

    The HytaleModding wiki allows for page customization through three primary methods:

    1. Markdown: Use standard Markdown syntax for text formatting, including headings, lists, tables, code blocks, and alerts.
    2. Images: Insert and configure images to enhance visual content.
    3. Custom CSS: Apply custom styles to modify the appearance of your wiki pages.

  10. Monitor server performance and player activity with HytaleMetrics

    main

    HytaleMetrics offers several categories of monitoring and analytics:

    Server Performance

    • Real-Time Monitoring: Track live player counts, concurrent sessions, TPS (Ticks Per Second), memory usage, and overall server health via responsive dashboards.
    • Network Support: For those managing multiple servers, a unified dashboard allows for simultaneous tracking of all servers in a network, including network-wide analytics and individual server breakdowns.

    Player Analytics

    • Profiles & Patterns: Access individual player profiles containing complete session history and playtime patterns.
    • Retention Tracking: Measure Day 1, Day 7, and Day 30 retention rates to identify player drop-off points.
    • Geographic Insights: View worldwide connection data to see where players are connecting from.
    • Custom Event Tracking: Monitor specific in-game activities such as quests, PvP kills, or any other custom events.

    Engagement & Growth

    • Vote Tracking: Monitor engagement via server listing sites.
    • Peak Hour Analysis: Identify peak activity times to optimize staff schedules and server events.
    • Integrations: Use export capabilities and API access for external data integrations.

  12. Hynergy Stage 1 release details

    main

    Stage 1 is the initial release phase of Hynergy. It focuses on establishing the core energy behaviors of the mod by providing essential mechanical and electrical components.

    Included in Stage 1:

    • Core mechanical components (generation and transmission).
    • Early electrical systems (basic generators and simple cables).
    • Essential blocks for learning how systems connect, react to load, and scale.

    Note: Content is subject to change as the mod is in an early phase of development.