7

Home

Mees van der Wijk edited this page 2025-08-14 18:43:48 +02:00

Table of Contents

• Introduction
• Key Principles
• Getting Started

Introduction

Introducing Getiyo—built by Morphix Productions—as your cutting-edge, virtual convergence hub for dynamic, interactive content delivery. Unleash the power of live streams, immersive gatherings, precision narrowcasting, seamless automations, theatrical experiences, and next-level show control. Effortlessly craft scenes with modules in our sleek, intuitive editor and publish them to multiple display endpoints with lightning-fast synchronization. Sit back as Getiyo orchestrates fluid transitions and generates visually striking animations between scene metamorphoses. Embrace the future of digital interactivity with Getiyo!

Key Principles

Modules in Getiyo are structured with a clear separation of concerns:

• Server Side
  The backbone of each module—handling data processing, business logic, and secure configuration. Server-side scripts leverage the ModuleServerAPI to:

  • Module Properties: which store sensitive or persistent data (API keys, authentication tokens, settings etc...). Defined in module.json, these properties remain hidden from clients and are accessed or updated exclusively via server-side code, ensuring integrity and confidentiality.
  • Orchestrate show control, file management, and communication with external services, powering the real-time behavior of your module.

• User
  The interactive front end of each module, where visual presentation and dynamic behavior come to life:

  • User Page: Every module must provide a user page (HTML, TS/JS, and CSS/SCSS) that defines its core UI. This page communicates with the server via the ModuleClientAPI, driving live interactivity and synchronized displays.
  • Reference Properties: For real-time, client-side customization, reference properties control styling (colors, fonts, layouts), animations, and on-the-fly content updates. Declared in module.json, they push live changes from the editor or during broadcast sessions directly into the client via api.onPropertyUpdate(), eliminating the need for redeployment.

Most modules will rely solely on these two layers—server-side logic with secure module properties, and a user-facing interface enriched by live-updatable reference properties. Control or external pages are available for advanced use cases (custom moderation UIs or standalone module views) but are optional and should be added only when necessary.

Getting Started

Development Environment	ModuleServerAPI	ModuleClientAPI
Module Structure	Introduction	Introduction
GetiyoModuleTool	Documentation	Documentation

Getting Started

• Introduction
• Prerequisites
• Setting up server
• Config

Module Development

• Introduction
• V2 Module Structure
  • module.ts
• V1 Module Structure
  • module.json
• Development environment/Building
• Module Config
  • Property
  • Trigger
  • Condition
• Module Debugging
• GetiyoModuleTool
  • ModuleStore
• Bug/Feature Reporting
• Contact Details

ModuleServerAPI

• Introduction
• ModuleServerAPI
  • Database
  • Client
  • Property
  • Important Principals
  • Libs
    • LibWebSocket
      • Communication Standard
    • Axios

ModuleServerAPI GameLib

• Introduction
• GameLib
  • Room
  • Game
    • GamePlayer
    • Scoreboard
      • Details
      • State
  • GameLib CollisionSpace

ModuleClientAPI

• Introduction
• ModuleClientAPI
  • User
  • Property
  • Neighbor
    • Neighbor Results
  • GameLib
    • Controller
  • Important Principals

ModuleApi Shared

• RuntimeStorage
• Gamelib
  • GameLib GameDetails
  • GameLib EndScreen
  • GameLib TimeSpan
  • GameLib FrameCycle
  • GameLib Ratio

© Vix Entertainment 2023 - © Mooren Productief 2023 - All rights reserved