1

ServerSetup

Mees van der Wijk edited this page 2023-04-05 12:21:02 +02:00

Table of Contents

• Setting up server
• Initial setup
• Forgot all admin passwords?
• Installing modules from store

Setting up server

Effortlessly set up your Getiyo server by simply running the provided executable. Watch as the server initializes, storing all data in a designated folder located at %userhome%/MorphixProductions/Getiyo.

Initial setup

Upon launching Getiyo for the first time, the system will generate the required directory structure within the data folder. By default, the server operates on port 4080, but this can be easily customized in the config. A temporary admin user will also be created, which remains active until another admin user is established. Follow these steps to create an account with your own credentials as the server admin:

1. Create a new user on http://serverip:4080/login, when finished you'll be logged into the account.
2. Log out and log in again to the temporary admin account with the following credentials:

   Email admin@getiyo.com
   Password Getiyo12345!

3. Head over to the user management page at http://serverip:4080/admin/users and find your newly created account in the list.
4. Enable the admin toggle on your account. You'll be immediately logged out and the temporary admin account will be disabled.
5. Now your account is an admin and can make other users admin.

Forgot all admin passwords?

1. Navigate to %userhome%/MorphixProductions/Getiyo/users
2. Remove all admin user files from the directory
3. Restart the server and repeat the steps above

Installing modules from store

To supercharge your testing and development experience, easily access and install additional modules for crafting dynamic scenes. First, ensure you've configured the ModuleStore browser key. Then, follow these simple steps:

1. Visit the admin modules page at http://serverIp:4080/admin/modules.
2. Click the 'Browse Store' button in the top right corner.
3. Open a module you'd like to install and click 'Install'

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