Added outline to main page
54
Home.md
54
Home.md
@@ -21,3 +21,57 @@ Modules in Getiyo are structured with a clear separation of concerns:
|
|||||||
- **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.
|
- **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.
|
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.
|
||||||
|
|
||||||
|
## Outline
|
||||||
|
|
||||||
|
- [Introduction](./Home)
|
||||||
|
- [Prerequisites](./Prerequisites)
|
||||||
|
- [Setting up server](./ServerSetup)
|
||||||
|
- [Config](./Config)
|
||||||
|
- Module Development
|
||||||
|
|
||||||
|
- [Module Structure](./ModuleStructure)
|
||||||
|
- [Module.json](./ModuleJSON)
|
||||||
|
- [Property](./ModuleJSONProperty)
|
||||||
|
- [Trigger](./ModuleTrigger)
|
||||||
|
- [Condition](./ModuleCondition)
|
||||||
|
- [Complete Example](./module.json)
|
||||||
|
- [Development environment/Building](./ModuleEnvironment)
|
||||||
|
- [GetiyoModuleTool](./GetiyoModuleTool)
|
||||||
|
- [ModuleClientAPI](./ModuleClientAPI)
|
||||||
|
- [Important Principals](./ModuleClientAPIPrincipals)
|
||||||
|
- [User](./ModuleClientAPIUser)
|
||||||
|
- [Neighbor](./ModuleClientAPINeighbor)
|
||||||
|
- [Neighbor Results](./ModuleClientAPINeighborResults)
|
||||||
|
- [GameLib](./ModuleClientAPIGameLib)
|
||||||
|
- [Controller](./ModuleClientAPIGameLibController)
|
||||||
|
- [ModuleServerAPI](./ModuleServerAPI)
|
||||||
|
|
||||||
|
- [Important Principals](./ModuleServerAPIPrincipals)
|
||||||
|
- [Client](./ModuleServerAPIClient)
|
||||||
|
- [Property](./ModuleServerAPIProperty)
|
||||||
|
- [GameLib](./ModuleServerAPIGameLib)
|
||||||
|
- [Room](./ModuleServerAPIGameLibRoom)
|
||||||
|
- [Game](./ModuleServerAPIGameLibGame)
|
||||||
|
- [GamePlayer](./ModuleServerAPIGameLibGamePlayer)
|
||||||
|
- [Scoreboard](./ModuleServerAPIGameLibScoreboard)
|
||||||
|
- [Details](./ModuleServerAPIGameLibScoreboardDetails)
|
||||||
|
- [State](./ModuleServerAPIGameLibScoreboardState)
|
||||||
|
- [GameLib CollisionSpace](./ModuleServerAPIGameLibCollisionSpace)
|
||||||
|
- [Libs](./ModuleServerAPILibs)
|
||||||
|
- [LibWebSocket](./ModuleServerAPILibsWebSocketLib)
|
||||||
|
- [Axios](https://axios-http.com/docs/instance)
|
||||||
|
|
||||||
|
- ModuleApi Shared
|
||||||
|
- [RuntimeStorage](./ModuleApiGameLibRuntimeStorage)
|
||||||
|
- Gamelib
|
||||||
|
- [GameLib GameDetails](./ModuleApiGameLibGameDetails)
|
||||||
|
- [GameLib EndScreen](./ModuleAPIGameLibEndScreen)
|
||||||
|
- [GameLib TimeSpan](./ModuleApiGameLibTimeSpan)
|
||||||
|
- [GameLib FrameCycle](./ModuleApiGameLibFrameCycle)
|
||||||
|
- [GameLib Ratio](./ModuleAPIGameLibRatio)
|
||||||
|
- [Module Debugging](./ModuleDebugging)
|
||||||
|
- [ModuleStore](./ModuleStore)
|
||||||
|
|
||||||
|
- [Bug/Feature Reporting](./Reporting)
|
||||||
|
- [Contact Details](./ContactDetails)
|
||||||
|
|||||||
Reference in New Issue
Block a user