Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Updated specs

Mees van der Wijk
2025-08-28 00:49:03 +02:00
parent 25f56779b6
commit e780bd0ba2
7 changed files with 37 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
GetiyoModuleTool.md

@@ -22,14 +22,18 @@ Watch a module workspace and combine on `b` keypress.
Create a new development environment. GMT will ask some questions to generate the wanted environment settings. Create a new development environment. GMT will ask some questions to generate the wanted environment settings.
## `install` ## `upgrade`
Install the current build in .dist to your local server. Upgrade the [ModuleServerAPI](./ModuleServerAPIIntroduction) and [ModuleClientAPI](./ModuleClientAPIIntroduction) type definitions within a existing module workspace.
## `publish` ## `publish`
Publish the latest build to the [ModuleStore](./ModuleStore). Publish the latest build to the [ModuleStore](./ModuleStore).
## `install`
Install the current build in .dist to your local server.
## `set <property> <value` ## `set <property> <value`
Update a GMT settings. Update a GMT settings.

10
ModuleClientAPI.md

@@ -275,7 +275,7 @@ api.getNeighbors(filter);
| -------- | --------------------------------------------------------------- | --------------------------------------------- | | -------- | --------------------------------------------------------------- | --------------------------------------------- |
| filter | { moduleId?:string, moduleType?:string, moduleTypes?:string[] } | The filter other modules have to comply with. | | filter | { moduleId?:string, moduleType?:string, moduleTypes?:string[] } | The filter other modules have to comply with. |
**Returns** [NeighborResults](./ModuleClientAPINeighborResults.md) _NeighborResults instance._ **Returns** [NeighborResults](./ModuleClientAPINeighborResults) _NeighborResults instance._
### onNeighborMessage ### onNeighborMessage
@@ -285,10 +285,10 @@ Register a listener for incoming neighbor messages.
api.onNeighborMessage(header, callback); api.onNeighborMessage(header, callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
| -------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | -------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| header | string | The header to listen for. | | header | string | The header to listen for. |
| callback | ( neighbor:[Neighbor](./ModuleClientAPINeighbor.md), ...args ):void | Callback for when a packet is received. Args is the data in the same order as when it was send. | | callback | ( neighbor:[Neighbor](./ModuleClientAPINeighbor), ...args ):void | Callback for when a packet is received. Args is the data in the same order as when it was send. |
## Utils ## Utils

2
ModuleConfigCondition.md

@@ -24,4 +24,4 @@ Although these two types of conditions function differently you specify them the
| title | Visual title of the condition | | title | Visual title of the condition |
| description | Short description that explains what the condition does | | description | Short description that explains what the condition does |
View [module.json](./ModuleJSON.md). View [module.json](./ModuleJSON).

2
ModuleConfigProperty.md

@@ -125,4 +125,4 @@ Grab animation from Giphy
|-|-|-| |-|-|-|
|value|null| |value|null|
View [module.json](./ModuleJSON.md). View [module.json](./ModuleJSON).

2
ModuleConfigTrigger.md

@@ -60,4 +60,4 @@ Scene select argument
} }
``` ```
View [module.json](./ModuleJSON.md). View [module.json](./ModuleJSON).

41
ModuleEnvironment.md

@@ -1,28 +1,31 @@
# Development environment # Development environment
Making your own modules is quite easy if you know the basic workflow. First, you need to set up the global [GetiyoModuleTool](./GetiyoModuleTool) and from there it's fast and easy to set up an environment or build a module. Making your own modules is quite easy if you know the basic workflow. First, you need to set up the global [GetiyoModuleTool](./GetiyoModuleTool) and from there it's fast and easy to set up an environment or build a module.
## Setting up for the first time ## Setting up for the first time
1) Make sure you have [Node.js LTS](https://nodejs.org/en/) installed.
2) Clone the GetiyoModuleTool from [the repository](https://git.mooren.tv/Getiyo/Getiyo-Module-Tool). 1. Make sure you have [Node.js LTS](https://nodejs.org/en/) installed.
3) Navigate into the directory and run ```npm i``` 2. Clone the GetiyoModuleTool from [the repository](https://git.mooren.tv/Getiyo/Getiyo-Module-Tool).
4) Wait for the process to finish and run ```npm install -g``` 3. Navigate into the directory and run `npm i`
5) After the process is finished verify by running ```gmt``` 4. Wait for the process to finish and run `npm install -g`
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](./Config.md). 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](./Config).
## Creating a module environment ## 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``` 1. Create a directory where you'd like to create the module workspace and open a terminal there.
3) GMT will ask some questions to create the module.json 2. Run `gmt create`
4) After the questions, the environment will be created. 3. GMT will ask some questions to create the module.json
5) You can now open the directory with your preferred IDE. 4. After the questions, the environment will be created.
5. You can now open the directory with your preferred IDE.
## Building a module ## 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.](./GetiyoModuleTool.md) 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.](./GetiyoModuleTool)

2
V2ModuleStructure.md

@@ -29,7 +29,7 @@ Module Root
## Module.ts ## Module.ts
The module.ts file serves as the central configuration file for each module in Getiyo. Unlike the old `module.json` file it has full type definitions making it easier to configure. It contains essential metadata that informs Getiyo about the module's identity, as well as the module's properties, triggers, and conditions. The [GetiyoModuleTool](./GetiyoModuleTool) can automatically generate this file for you, streamlining the setup process. However, if you want to modify or add properties, triggers, or conditions, you can refer to the module.json section in the documentation. To learn more about the [module.ts](./ModuleTS.md) file. The module.ts file serves as the central configuration file for each module in Getiyo. Unlike the old `module.json` file it has full type definitions making it easier to configure. It contains essential metadata that informs Getiyo about the module's identity, as well as the module's properties, triggers, and conditions. The [GetiyoModuleTool](./GetiyoModuleTool) can automatically generate this file for you, streamlining the setup process. However, if you want to modify or add properties, triggers, or conditions, you can refer to the module.json section in the documentation. To learn more about the [module.ts](./ModuleTS) file.
## Server-Side ## Server-Side