2

ModuleEnvironment

Mees van der Wijk edited this page 2025-08-28 00:49:03 +02:00

Table of Contents

• Development environment
• Setting up for the first time
• Creating a module environment
• Building a module

Development environment

Making your own modules is quite easy if you know the basic workflow. First, you need to set up the global GetiyoModuleTool and from there it's fast and easy to set up an environment or build a module.

Setting up for the first time

1. Make sure you have Node.js LTS installed.
2. Clone the GetiyoModuleTool from the repository.
3. Navigate into the directory and run npm i
4. Wait for the process to finish and run npm install -g
5. After the process is finished verify by running gmt
6. It should output the arguments list for GMT. To effectively build modules, GMT has a build-in way to restart your Getiyo server. However, this requires that the development mode is turned on in the config.

Creating a module environment

1. Create a directory where you'd like to create the module workspace and open a terminal there.
2. Run gmt create
3. GMT will ask some questions to create the module.json
4. After the questions, the environment will be created.
5. You can now open the directory with your preferred IDE.

Building a module

1. Open the root directory of the module environment in a terminal.
2. Run gmt build
3. Additionally, you can also let GMT automatically install the module to your local server with the argument --output-server
4. You can also restart the server with --stop-server but development mode has to be turned on and you have to configure your server details first with:
   • gmt set ip <serverip>
   • gmt set port <port>

Full documentation of the GetiyoModuleTool.

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