Add user & dev docs, update reference docs

docs/.vitepress/data/sidebar.ts

@@ -11,14 +11,36 @@ export default {
                     link: '/'
                 },
                 {
-                    text: 'Introduction',
+                    text: 'Room Setup',
-                    link: '/getting-started/introduction'
+                    link: '/getting-started/room-setup'
+                },
+            ]
         },
         {
-                    text: 'Installation',
+            text: 'General',
-                    link: '/getting-started/installation'
+            items: [
+                {
+                    text: 'Hand Tracking',
+                    link: '/getting-started/hand-tracking'
+                },
+                {
+                    text: 'Miniature View',
+                    link: '/getting-started/mini-view'
+                },
+                {
+                    text: 'Voice Assistant',
+                    link: '/getting-started/voice-assistant'
                 }
             ]
+        },
+        {
+            text: 'Smart Home Integration',
+            items: [
+                {
+                    text: 'Home Assistant',
+                    link: '/vendor-integration/home-assistant'
+                },
+            ]
         }
     ],
     '/development/': [
@@ -26,8 +48,29 @@ export default {
             text: 'Development',
             items: [
                 {
-                    text: 'General',
+                    text: 'Getting Started',
                     link: '/development/'
+                },
+                {
+                    text: 'Testing',
+                    link: '/development/testing'
+                },
+                {
+                    text: 'Building',
+                    link: '/development/building'
+                },
+                {
+                    text: 'Systems',
+                    items: [
+                        {
+                            text: 'Home API',
+                            link: '/development/home-api'
+                        },
+                        {
+                            text: 'Event System',
+                            link: '/development/event-system'
+                        }
+                    ]
                 }
             ]
         }

docs/.vitepress/theme/style.css

@@ -138,3 +138,7 @@
   --docsearch-primary-color: var(--vp-c-brand-1) !important;
 }
 
+iframe {
+  aspect-ratio: 16 / 9;
+  width: 100%;
+}

docs/development/building.md

@@ -0,0 +1,16 @@
+# Building
+
+
+1. Follow the following [guide](https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html) to setup exporting for android.
+2. Make sure to reuse any existing `debug.keystore` when updating an app
+3. Don't forget to set the `JAVA_HOME` variable and restart Godot to take effect
+4. Install the Godot XR Android OpenXR Loaders plugin in Godot
+
+You now should be able to export the app to Android.
+
+::: tip
+```xml
+<uses-feature android:name="com.oculus.feature.CONTEXTUAL_BOUNDARYLESS_APP" android:required="true" />
+```
+This can be added to the `AndroidManifest.xml` to disable the boundary system when the app is running.
+:::

docs/development/event-system.md

@@ -0,0 +1,9 @@
+# Event System
+
+While Godot ships with it's own event system, we have implemented our own event system to make it more similar to the event system in Browsers and to streamline event handling in the app.
+
+Full reference can be found in the [Event System](/reference/lib--globals--event_system.html) documentation.
+
+## Focus handling
+
+By default, every Node that has the `ui_focus` group is able to receive focus. When a node receives focus, the **_on_focus_in(event: [EventFocus](/reference/EventFocus.html))** method is called. When a node loses focus, the **_on_focus_out(event: [EventFocus](/reference/EventFocus.html))** method is called.

docs/development/home-api.md

@@ -0,0 +1,9 @@
+# HomeApi
+
+The `HomeApi` is a global singleton that is used to communicate with the smart home environment. It is responsible for fetching the current state of the environment and sending commands to the environment.
+
+::: info
+It is possible to write your own adapters for different smart home environments. For the time being, only Home Assistant is supported and extended by us. If you want to add support for another smart home environment, please reach out to us on [GitHub](https://github.com/nitwel/immersive-home) or [Discord](https://discord.gg/QgUnAzNVTx).
+:::
+
+For detailed information on how to use the `HomeApi`, please refer to the [Reference](/reference/lib--globals--home_api.html).

docs/development/index.md

@@ -0,0 +1,72 @@
+# Getting Started
+
+Thanks for your interest in contributing to the project! This guide will help you get started with the development environment and the project structure.
+
+## Prerequisites
+
+In order to contribute to this project, you need to have [Godot 4.2.x](https://godotengine.org/download/archive/) installed on your computer.
+
+[Git](https://git-scm.com/) and [Git-LFS](https://git-lfs.com/) is also required to clone the repository and download the large binary files.
+
+## Local Development
+
+1. Clone the repository from GitHub:
+
+```bash
+git clone https://github.com/Nitwel/Immersive-Home.git
+```
+
+2. Open the project in your Editor of choice. We recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Godot Tools](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools) extension.
+
+3. Open Godot and import the project by selecting the `project.godot` file in the root of the repository.
+
+::: warning
+Development is currently **only supported on Windows and Linux**. If you are using a Mac, the project might not work correctly due to the `godot-cdt` addon only having binaries for Windows and Linux.
+:::
+
+## Fundamentals
+
+Communication with the Smart Home Environment is done using the HomeApi global. Each environment is made up of devices and entities. A device is a collection of different entities and entities can represent many different things in a smart home. For example, the entity of name `lights.smart_lamp_1` would control the kitchen lamps while `state.smart_lamp_1_temp` would show the current temperature of the lamp.
+
+### File Structure
+
+```plaintext
+.
+├── app/               (Main Godot Project)
+│   ├── addons             (All installed Godot Addons are saved here)
+│   ├── assets             (Files like logos or assets that are shared across scenes)
+│   ├── content/           (Main files of the project)
+│   │   ├── entities       (Entities that can be placed into the room)
+│   │   ├── functions      (Generic functions that can be used in scenes)
+│   │   └── ui             (User Interface Scenes and related files)
+│   └── lib/               (Shared code)
+│       ├── globals        (Globally running scripts)
+|       ├── home_apis       (Code that communicates with the smart home environment)
+|       ├── stores         (Stores that hold the state of the app)
+│       └── utils          (Utility functions)
+├── docs/              (Documentation)
+│   ├── development        (Development related documentation)
+│   ├── getting-started    (Getting started guides)
+│   └── vendor-integration (Integration guides for different smart home vendors)
+└── vendors/          (Vendor specific code)
+    └── home-assistant_integration (Home Assistant Integration)
+```
+
+### Scene Structure
+
+When the app starts, globals and the `main.tscn` are loaded. The `main.tscn` is the main scene of the app and is responsible for loading the other scenes.
+
+```plaintext
+root
+├── HomeApi      (Global access for talking to the smart home environment)
+├── EventSystem  (Global Event System)
+├── Store        (Global access the the app state)
+├── House        (Global House reference to the current house)
+└── Main         (Main Scene)
+```
+
+### Code Reference and Documentation
+
+Static code reference can be found in the Reference section of the documentation at the top right. It is exported from Godot and contains all available scripts from the `/lib` folder.
+
+The documentation is written in Markdown and can be found in the `docs` folder of the repository.

docs/development/testing.md

@@ -0,0 +1,11 @@
+# Testing
+
+## Without a VR Headset
+
+In order to test without a headset, press the run project (F5) button in Godot and ignore the prompt that OpenXR failed to start. To simulate the headset and controller movement, we're using the [XR Input Simulator](https://godotengine.org/asset-library/asset/1775) addon. Click at the link to get a list of the supported controls.
+
+## With a VR Headset
+
+To test the app with a VR headset, make sure you are able to export the project to Android. Follow the [Building](development/building.md) guide to setup the project for Android.
+
+When everything is setup correctly, you can connect your Headset to your computer and press the `Export with Remote Debug` button in Godot. This will start the app on your headset and connect the Godot Editor to the app. You can now see the logs and errors in the Godot Editor while the app is running on the headset.

docs/getting-started/hand-tracking.md

@@ -0,0 +1,28 @@
+# Hand Tracking
+
+## Video Tutorial
+
+<iframe src="https://www.youtube-nocookie.com/embed/1S_TiGtYZj4?si=4lKyBmKB56M4Sd46" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+## Interaction
+Hand tracking is very convenient to use, but hasn't been documented greatly yet in Immersive Home so this guide will give you a quick introduction on how to use it.
+
+### Clicking
+
+Clicking can be done using two ways. The first being from a distance by pinching your index and thumb finger together to click on a button. The second method is how you would normally interact with the real world using your index finger. Just press onto a button with your index finger and the button should trigger.
+
+> It should be said that the phyiscal interaction is not wiedly implemented yet so in some cases you have to fallback to the pinch gesture.
+
+### Moving
+
+You can move object by pinching your middle and thumb finger together or when you're close enough, also by pinching the index and thumb finger together.
+
+### Opening the menu
+
+The menu can be opened and closed by pressing index and thumb finger together while pointing both fingers in the direction of your headset. 
+
+![Index and Thumb finger pressed together](https://login.immersive-home.org/assets/201b909e-7fff-49f4-8426-00b007b904f1)
+
+----
+
+More gestures will come in the future to make interactions even quicker.

docs/getting-started/mini-view.md

@@ -0,0 +1,5 @@
+# Miniature View
+
+The miniature view is a small copy of your home that allows you to reach entities that are far away or in a different room. It can be opened by pressing the **Y** button on the left controller or by pressing the Mini view Button in the Menu (the first tab from the top).
+
+![Miniature View](/img/mini-view.jpg)

docs/getting-started/room-setup.md

@@ -0,0 +1,54 @@
+# Room Setup
+
+## Video Tutorial
+
+<iframe src="https://www.youtube-nocookie.com/embed/8t66SH6ZbEE?si=-yEmwCJpE2mvjg6Z" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+## Introduction
+
+In order to be able to add entities into your virtual home, you have to configure the rooms first. Otherwise you will get an error message like on the image below.
+
+![Error adding Entity outside of a Room](/img/room-setup-1.png)
+
+## Adding a Room
+
+1. Open the Menu
+2. Click on the 3rd button from the top to open the Room Setup Panel
+3. Click on the **Room** button to open the Rooms tab.
+
+![Panel where a room can be added](/img/room-setup-2.png)
+
+4. Click on the + button to add a new room.
+5. Enter the name of the room
+6. Click in a corner on the floor to add the initial corner
+
+![Corner of Room](/img/room-setup-3.png)
+
+7. Adjust the height of the room by moving the upper circle until it matches the height of the room
+8. Click on another corner on the ceiling to add the second corner
+9. Continue adding corners to the ceiling until the room is fully enclosed
+10. Click on the **Save** button to save the room
+
+![Room fully configured](/img/room-setup-4.png)
+
+## Reference Point
+ 
+The reference point will allow you to fix the positioning of your rooms in case they got changed after you redid your boundary or similar. Here the steps:
+
+1. Go to the Overview tab of the Room menu
+2. Click on the edit button (pen icon)
+3. Locate and move the Reference point to a desired location, for example an image hanging on the wall or a window
+4. Press the save button
+
+The result should look something like this:
+
+![Reference Point next to Image](/img/reference-point.png)
+
+In case that your room now has moved after starting the app again, you can do the following to fix the alignment again:
+
+1. Go to the Overview tab of the Room menu
+2. Click on the fix button (band aid icon)
+3. Move the Reference Point back to it's original position
+4. Press the save button
+
+This should result in the room being in the right spot again. In case there is something wrong at the moment, restart the app and everything should be back to normal.

docs/getting-started/voice-assistant.md

@@ -0,0 +1,21 @@
+# Voice Assistant
+
+The voice assistant is a feature that allows you to control your home using your voice. It is powered by the Home Assistant [voice control integration](https://www.home-assistant.io/voice_control/)
+
+![Voice Assistant](/img/voice-assistant-2.png)
+
+## Enabling the Voice Assistant
+
+First, you have to enable the voice assistant in the settings panel. You can do this by opening the menu and clicking on the settings button. Then, click on the microphone button to enable the voice assistant.
+
+::: warning
+There is currently a problem with the app not being able to select the correct microphone after enabling the voice assistant. If you have problems with the voice assistant, try restarting the app.
+:::
+
+## Using the Voice Assistant
+
+The voice assistant will constantly listen for the wake word you have selected in Home Assistant. When it hears the wake word, it will display loading circles below your view.
+
+![Voice Assistant Loading](/img/voice-assistant-1.png)
+
+While the loading circles are displayed, you can say a command. The command will then be displayed with the response from the Assistant and the response will be spoken out loud.

docs/index.md

@@ -1 +1,66 @@
 # Quick Start Guide
+
+This guide will help you get started with installing and configuring the app.
+
+## Prerequisites
+
+The app requires that you have hosted [Home Assistant](https://www.home-assistant.io/) somewhere in your network or accessible from the internet.
+
+The app currently only supports the **Meta Quest 2, Pro and 3**, other headsets like Pico 4 might work but are not officially supported yet.
+
+## Download
+
+You can download the app from the following sources:
+
+- [Meta App Lab](https://www.oculus.com/experiences/quest/7533875049973382/) for $4.99 USD
+- [Itch.io](https://nitwel.itch.io/immersive-home) for $4.99 USD
+- [SideQuest](https://sidequestvr.com/app/26827/immersive-home) for free
+- [GitHub](https://github.com/Nitwel/Immersive-Home/releases/latest/download/Android.zip) for free
+
+::: info
+The app is free to use, but if you want to support the project, you can buy it from the Meta App Lab or Itch.io. The benefit of buying it from the App Lab is that you will get automatic updates.
+:::
+
+## Installation to the Headset
+
+If you bought the app from the Meta App Lab, you can skip this step.
+
+In order to install the app on your headset, you will need to use [SideQuest](https://sidequestvr.com/setup-howto) to install APK files to the headset.
+
+1. Download the APK from the source you chose.
+2. Connect your headset to your computer.
+3. Open the [SideQuest](https://sidequestvr.com/setup-howto) app.
+4. Drag and drop the APK file into the SideQuest window.
+
+## Creating a Token to access Home Assistant
+
+In order to access your Home Assistant instance from the app, you will need to create a Long-Lived Access Token.
+
+In the Home Assistant Dashboard, do the following:
+
+1. Click on your user profile in the bottom left corner.
+2. Scroll to the bottom and click on **create token** under "Long-Lived Access Tokens".
+
+![Home Assistant Dashboard](/img/setup-1.jpg)
+
+3. Open the Menu in the app and open the settings panel by either:
+    - Pressing the **Menu** button on the left controller.
+    - making the pinch gesture with the left hand while you palm points into your direction.
+4. Enter the URL of your Home Assistant instance and the token you just created. Make sure to change `http` -> `ws` or `https` -> `wss` in the URL.
+
+::: tip
+The fastest way to enter the token and URL is to send a message to your headset with the token and URL and then copy each part inside the headset.
+The bottom right button on the keyboard will paste the copied text into the input field.
+:::
+
+5. Finally, by clicking the **Connect** button, the app will try to connect to your Home Assistant instance. If everything is correct, you will see the text change to **Connected** below the button.
+
+![Setting Panel in the app](/img/setup-2.jpg)
+
+## What's next?
+
+You successfully connected the app to Home Assistant. Next up you have to configure the rooms, read more about it in the [Room Setup](/room-setup) section.
+
+::: warning
+Rooms have to be configured first, before you can add entities to them.
+:::

docs/reference/CallbackMap.md

@@ -1,4 +1,5 @@
 # CallbackMap
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 ## Description
 
@@ -21,6 +22,10 @@ A simple class to manage callbacks for different keys
 | void    | [call_key](#call-key) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), args: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) )           |
 | void    | [remove](#remove) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) )     |
 
+
+
+
+
 ## Property Descriptions
 
 ### callbacks: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#callbacks}

docs/reference/EntityFactory.md

@@ -1,4 +1,5 @@
 # EntityFactory
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -12,6 +13,52 @@
 
 
 
+## Constants
+
+
+### Switch = `<Object>` {#const-Switch}
+
+No description provided yet.
+                
+
+
+### Light = `<Object>` {#const-Light}
+
+No description provided yet.
+                
+
+
+### Sensor = `<Object>` {#const-Sensor}
+
+No description provided yet.
+                
+
+
+### MediaPlayer = `<Object>` {#const-MediaPlayer}
+
+No description provided yet.
+                
+
+
+### Camera = `<Object>` {#const-Camera}
+
+No description provided yet.
+                
+
+
+### ButtonEntity = `<Object>` {#const-ButtonEntity}
+
+No description provided yet.
+                
+
+
+### NumberEntity = `<Object>` {#const-NumberEntity}
+
+No description provided yet.
+                
+
+
+
 ## Method Descriptions
 
 ### create_entity (id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-entity}

docs/reference/Event.md

@@ -1,4 +1,5 @@
 # Event
+**Inherits:** [Resource](https://docs.godotengine.org/de/4.x/classes/class_resource.html)
     
 
 
@@ -7,13 +8,17 @@
 ## Methods
 
 | Returns | Name                                                      |
-| ------- | ------------------------------------------------------------------------------------------------ |
+| ------- | --------------------------------------------------------- |
-| void    | [merge](#merge) ( event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) |
+| void    | [merge](#merge) ( event: [Event](/reference/Event.html) ) |
+
+
+
+
 
 
 
 ## Method Descriptions
 
-### merge ( event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#merge}
+### merge (event: [Event](/reference/Event.html)  ) -> void {#merge}
 
 No description provided yet.

docs/reference/EventAction.md

@@ -1,4 +1,5 @@
 # EventAction
+**Inherits:** [Event](/reference/Event.html)
     
 
 
@@ -12,6 +13,10 @@
 
 
 
+
+
+
+
 ## Property Descriptions
 
 ### name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#name}

docs/reference/EventBubble.md

@@ -1,4 +1,5 @@
 # EventBubble
+**Inherits:** [Event](/reference/Event.html)
     
 
 
@@ -11,6 +12,10 @@
 
 
 
+
+
+
+
 ## Property Descriptions
 
 ### bubbling: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#bubbling}

docs/reference/EventFocus.md

@@ -1,4 +1,5 @@
 # EventFocus
+**Inherits:** [Event](/reference/Event.html)
     
 
 
@@ -11,6 +12,10 @@
 
 
 
+
+
+
+
 ## Property Descriptions
 
 ### previous_target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#previous-target}

docs/reference/EventKey.md

@@ -1,4 +1,5 @@
 # EventKey
+**Inherits:** [EventWithModifiers](/reference/EventWithModifiers.html)
     
 
 
@@ -15,6 +16,10 @@
 | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | [key_to_string](#key-to-string) ( key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html), caps: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html), apply_to: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
 
+
+
+
+
 ## Property Descriptions
 
 ### echo: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#echo}

docs/reference/EventNotify.md

@@ -1,4 +1,5 @@
 # EventNotify
+**Inherits:** [Event](/reference/Event.html)
     
 
 
@@ -11,6 +12,34 @@
 
 
 
+
+
+## Constants
+
+
+### INFO = `0` {#const-INFO}
+
+No description provided yet.
+                
+
+
+### SUCCESS = `1` {#const-SUCCESS}
+
+No description provided yet.
+                
+
+
+### WARNING = `2` {#const-WARNING}
+
+No description provided yet.
+                
+
+
+### DANGER = `3` {#const-DANGER}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#message}

docs/reference/EventPointer.md

@@ -1,4 +1,5 @@
 # EventPointer
+**Inherits:** [EventBubble](/reference/EventBubble.html)
     
 
 
@@ -11,6 +12,16 @@
 
 
 
+
+
+## Constants
+
+
+### Initiator = `<Object>` {#const-Initiator}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#initiator}

docs/reference/EventTouch.md

@@ -1,4 +1,5 @@
 # EventTouch
+**Inherits:** [EventBubble](/reference/EventBubble.html)
     
 
 
@@ -14,6 +15,16 @@
 | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_finger](#has-finger) ( finger: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) |
 
+
+
+## Constants
+
+
+### Finger = `<Object>` {#const-Finger}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### fingers: [Finger](/reference/lib--utils--touch--finger.html)[] {#fingers}

docs/reference/EventWithModifiers.md

@@ -1,4 +1,5 @@
 # EventWithModifiers
+**Inherits:** [Event](/reference/Event.html)
     
 
 
@@ -13,6 +14,10 @@
 
 
 
+
+
+
+
 ## Property Descriptions
 
 ### alt_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#alt-pressed}

docs/reference/Proxy.md

@@ -1,4 +1,5 @@
 # Proxy
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -16,6 +17,14 @@
 | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | void    | [_init](#-init) ( gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
 
+## Signals
+
+### on_set (new_value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html)  ) {#on-set}
+
+No description provided yet.
+
+
+
 ## Property Descriptions
 
 ### gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#gettable}

docs/reference/ProxyGroup.md

@@ -1,4 +1,5 @@
 # ProxyGroup
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -14,6 +15,10 @@
 | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [proxy](#proxy) ( _get: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), _set: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
 
+
+
+
+
 ## Property Descriptions
 
 ### proxies: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#proxies}

docs/reference/State.md

@@ -1,12 +1,13 @@
 # State
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
 ## Properties
 
 | Name                            | Type                                         | Default |
-| ------------------------------- | ----------------------------------------------------------------------------------- | ------- |
+| ------------------------------- | -------------------------------------------- | ------- |
-| [state_machine](#state-machine) | [StateMachine](https://docs.godotengine.org/de/4.x/classes/class_statemachine.html) |         |
+| [state_machine](#state-machine) | [StateMachine](/reference/StateMachine.html) |         |
 
 ## Methods
 
@@ -16,9 +17,13 @@
 | void                                                                      | [_on_leave](#-on-leave) (  ) |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [is_active](#is-active) (  ) |
 
+
+
+
+
 ## Property Descriptions
 
-### state_machine: [StateMachine](https://docs.godotengine.org/de/4.x/classes/class_statemachine.html) {#state-machine}
+### state_machine: [StateMachine](/reference/StateMachine.html) {#state-machine}
 
 No description provided yet.
 

docs/reference/StateMachine.md

@@ -1,4 +1,5 @@
 # StateMachine
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -17,6 +18,14 @@
 | void                                                                | [change_to](#change-to) ( new_state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )  |
 | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | [get_state](#get-state) ( state_name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
 
+## Signals
+
+### changed (state_name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , old_state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) {#changed}
+
+No description provided yet.
+
+
+
 ## Property Descriptions
 
 ### current_state: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#current-state}

docs/reference/generator/index.ts

@@ -7,6 +7,7 @@ import { markdownTable } from 'markdown-table'
 import endent from "endent";
 
 const REFERENCE_PATH = './reference/raw'
+let custom_types: string[] = []
 
 // export_from_godot()
 translate()
@@ -25,6 +26,17 @@ async function export_from_godot() {
 }
 
 async function translate() {
+    custom_types = (await readdir(REFERENCE_PATH)).map(file => {
+        file = file.replace('.xml', '').replace(/--/g, '/')
+
+        if (file.includes('--')) {
+            return `"${file}.gd"`
+        }
+
+        return file
+    })
+
+
     for (const file of await readdir(REFERENCE_PATH)) {
         const contents = await parse_reference(join(REFERENCE_PATH, file))
         const markdown = translate_reference(contents)
@@ -63,6 +75,51 @@ function translate_reference(contents: string): string {
             `
     }
 
+    let inherits = ''
+
+    if (json.class._inherits) {
+        inherits = endent`**Inherits:** ${link_godot_type(json.class._inherits)}`
+    }
+
+    let signal_descriptions = ''
+    let signals_list = to_array(json.class.signals?.signal)
+
+    if (signals_list.length > 0) {
+        signal_descriptions = '## Signals\n\n' +
+            signals_list.map(signal => {
+                const name = signal._name
+
+                let params = to_array(signal?.param).map(param => {
+                    return `${param._name}: ${link_godot_type(param._type)} `
+                }).join(', ')
+
+                return endent`
+                    ### ${name} (${params} ) ${'{#' + name_to_anchor(name) + '}'}
+
+                    ${signal.description || 'No description provided yet.'}
+                `
+            }).join('\n\n')
+    }
+
+
+    let constant_descriptions = ''
+    let constants_list = to_array(json.class.constants?.constant)
+
+    if (constants_list.length > 0) {
+        constant_descriptions = '## Constants\n\n' +
+            constants_list.map(constant => {
+                const name = constant._name
+
+                console.log('constant', constant._value)
+
+                return `
+### ${name} = \`${constant._value}\` ${'{#const-' + name_to_anchor(name) + '}'}
+
+${constant.description || 'No description provided yet.'}
+                `
+            }).join('\n\n')
+    }
+
     let members = ''
     let member_descriptions = ''
     let members_list = to_array(json.class.members?.member)
@@ -82,7 +139,8 @@ function translate_reference(contents: string): string {
                     handle_default(member._default)
                 ]
             })
-        ])}
+        ])
+            }
     `
 
         member_descriptions = '## Property Descriptions\n\n' +
@@ -121,7 +179,8 @@ function translate_reference(contents: string): string {
                     `[${name}](#${name_to_anchor(name)}) ( ${params} )`
                 ]
             })
-        ])}
+        ])
+            }
     `
 
         method_descriptions = '## Method Descriptions\n\n' +
@@ -142,6 +201,7 @@ function translate_reference(contents: string): string {
 
     let markdown = endent`
         # ${getTitle(json.class._name)}
+        ${inherits}
             
         ${description}
 
@@ -149,6 +209,10 @@ function translate_reference(contents: string): string {
 
         ${methods}
 
+        ${signal_descriptions}
+
+        ${constant_descriptions}
+
         ${member_descriptions}
 
         ${method_descriptions}
@@ -191,6 +255,10 @@ function link_godot_type(type: string): string {
         })
     }
 
+    if (custom_types.includes(type)) {
+        return `[${getTitle(type)}](/reference/${type}.html)`
+    }
+
     return `[${type}](https://docs.godotengine.org/de/4.x/classes/class_${type.toLowerCase()}.html)`
 }
 

docs/reference/lib--globals--audio_player.md

@@ -1,4 +1,5 @@
 # AudioPlayer
+**Inherits:** [AudioStreamPlayer](https://docs.godotengine.org/de/4.x/classes/class_audiostreamplayer.html)
     
 
 
@@ -18,6 +19,10 @@
 | void    | [_ready](#-ready) (  )                                                                                           |
 | void    | [play_effect](#play-effect) ( sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
 
+
+
+
+
 ## Property Descriptions
 
 ### click_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#click-sound}

docs/reference/lib--globals--event_system.md

@@ -1,4 +1,5 @@
 # EventSystem
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -12,15 +13,121 @@
 ## Methods
 
 | Returns                                                                   | Name                                                                                                                                                                                                                                                                                                                                      |
-| ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_bubble_call](#-bubble-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html), focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
+| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_bubble_call](#-bubble-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](/reference/EventBubble.html), focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
-| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_handle_focus](#-handle-focus) ( target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html) )                                                                                                                                                                  |
+| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_handle_focus](#-handle-focus) ( target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](/reference/EventBubble.html) )                                                                                                                                                                  |
 | void                                                                      | [_physics_process](#-physics-process) ( delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )                                                                                                                                                                                                                |
-| void                                                                      | [_root_call](#-root-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) )                                                                                                                                                                                        |
+| void                                                                      | [_root_call](#-root-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](/reference/Event.html) )                                                                                                                                                                                        |
-| void                                                                      | [emit](#emit) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) )                                                                                                                                                                                                    |
+| void                                                                      | [emit](#emit) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](/reference/Event.html) )                                                                                                                                                                                                    |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [is_focused](#is-focused) ( node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) )                                                                                                                                                                                                                                   |
 | void                                                                      | [notify](#notify) ( message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) )                                                                                                                                                           |
 
+## Signals
+
+### on_action_down (event: [EventAction](/reference/EventAction.html)  ) {#on-action-down}
+
+No description provided yet.
+
+### on_action_up (event: [EventAction](/reference/EventAction.html)  ) {#on-action-up}
+
+No description provided yet.
+
+### on_action_value (event: [EventAction](/reference/EventAction.html)  ) {#on-action-value}
+
+No description provided yet.
+
+### on_click (event: [EventPointer](/reference/EventPointer.html)  ) {#on-click}
+
+No description provided yet.
+
+### on_focus_in (event: [EventFocus](/reference/EventFocus.html)  ) {#on-focus-in}
+
+No description provided yet.
+
+### on_focus_out (event: [EventFocus](/reference/EventFocus.html)  ) {#on-focus-out}
+
+No description provided yet.
+
+### on_grab_down (event: [EventPointer](/reference/EventPointer.html)  ) {#on-grab-down}
+
+No description provided yet.
+
+### on_grab_move (event: [EventPointer](/reference/EventPointer.html)  ) {#on-grab-move}
+
+No description provided yet.
+
+### on_grab_up (event: [EventPointer](/reference/EventPointer.html)  ) {#on-grab-up}
+
+No description provided yet.
+
+### on_key_down (event: [EventKey](/reference/EventKey.html)  ) {#on-key-down}
+
+No description provided yet.
+
+### on_key_up (event: [EventKey](/reference/EventKey.html)  ) {#on-key-up}
+
+No description provided yet.
+
+### on_notify (event: [EventNotify](/reference/EventNotify.html)  ) {#on-notify}
+
+No description provided yet.
+
+### on_press_down (event: [EventPointer](/reference/EventPointer.html)  ) {#on-press-down}
+
+No description provided yet.
+
+### on_press_move (event: [EventPointer](/reference/EventPointer.html)  ) {#on-press-move}
+
+No description provided yet.
+
+### on_press_up (event: [EventPointer](/reference/EventPointer.html)  ) {#on-press-up}
+
+No description provided yet.
+
+### on_ray_enter (event: [EventPointer](/reference/EventPointer.html)  ) {#on-ray-enter}
+
+No description provided yet.
+
+### on_ray_leave (event: [EventPointer](/reference/EventPointer.html)  ) {#on-ray-leave}
+
+No description provided yet.
+
+### on_slow_tick (delta: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html)  ) {#on-slow-tick}
+
+No description provided yet.
+
+### on_touch_enter (event: [EventTouch](/reference/EventTouch.html)  ) {#on-touch-enter}
+
+No description provided yet.
+
+### on_touch_leave (event: [EventTouch](/reference/EventTouch.html)  ) {#on-touch-leave}
+
+No description provided yet.
+
+### on_touch_move (event: [EventTouch](/reference/EventTouch.html)  ) {#on-touch-move}
+
+No description provided yet.
+
+## Constants
+
+
+### FN_PREFIX = `"_on_"` {#const-FN-PREFIX}
+
+No description provided yet.
+                
+
+
+### SIGNAL_PREFIX = `"on_"` {#const-SIGNAL-PREFIX}
+
+No description provided yet.
+                
+
+
+### SLOW_TICK = `0.1` {#const-SLOW-TICK}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### _active_node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#-active-node}
@@ -33,11 +140,11 @@ No description provided yet.
 
 ## Method Descriptions
 
-### _bubble_call ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html), focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-bubble-call}
+### _bubble_call (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , event: [EventBubble](/reference/EventBubble.html) , focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-bubble-call}
 
 No description provided yet.
 
-### _handle_focus ( target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-handle-focus}
+### _handle_focus (target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , event: [EventBubble](/reference/EventBubble.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-handle-focus}
 
 No description provided yet.
 
@@ -45,11 +152,11 @@ No description provided yet.
 
 No description provided yet.
 
-### _root_call ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#-root-call}
+### _root_call (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , event: [Event](/reference/Event.html)  ) -> void {#-root-call}
 
 No description provided yet.
 
-### emit ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#emit}
+### emit (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , event: [Event](/reference/Event.html)  ) -> void {#emit}
 
 No description provided yet.
 

docs/reference/lib--globals--home_api.md

@@ -1,4 +1,5 @@
 # HomeApi
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -24,6 +25,42 @@
 | void                                                                      | [start_adapter](#start-adapter) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )            |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [watch_state](#watch-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) )                                                                                     |
 
+## Signals
+
+### on_connect ( ) {#on-connect}
+
+No description provided yet.
+
+### on_disconnect ( ) {#on-disconnect}
+
+No description provided yet.
+
+## Constants
+
+
+### Hass = `<Object>` {#const-Hass}
+
+No description provided yet.
+                
+
+
+### HassWebSocket = `<Object>` {#const-HassWebSocket}
+
+No description provided yet.
+                
+
+
+### apis = `{"hass": <Object>, "hass_ws": <Object>}` {#const-apis}
+
+No description provided yet.
+                
+
+
+### methods = `["get_devices", "get_device", "get_state", "set_state", "watch_state"]` {#const-methods}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#api}

docs/reference/lib--globals--house_body.md

@@ -1,4 +1,5 @@
 # HouseBody
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -10,6 +11,10 @@
 
 
 
+
+
+
+
 ## Property Descriptions
 
 ### body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#body}

docs/reference/lib--globals--main_store.md

@@ -1,4 +1,5 @@
 # MainStore
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -12,6 +13,28 @@
 
 
 
+
+
+## Constants
+
+
+### SettingsStore = `<Object>` {#const-SettingsStore}
+
+No description provided yet.
+                
+
+
+### HouseStore = `<Object>` {#const-HouseStore}
+
+No description provided yet.
+                
+
+
+### DevicesStore = `<Object>` {#const-DevicesStore}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### devices: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices}

docs/reference/lib--globals--request.md

@@ -1 +1,2 @@
 # Request
+**Inherits:** [HTTPRequest](https://docs.godotengine.org/de/4.x/classes/class_httprequest.html)

docs/reference/lib--home_apis--hass--hass.md

@@ -1,4 +1,5 @@
 # Hass
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -20,6 +21,10 @@
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )                                                                                                                                                                              |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [set_state](#set-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
 
+
+
+
+
 ## Property Descriptions
 
 ### devices_template: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices-template}

docs/reference/lib--home_apis--hass_ws--handlers--assist.md

@@ -1,4 +1,5 @@
 # Assist
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -24,6 +25,36 @@
 | void    | [send_data](#send-data) ( data: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) )    |
 | void    | [start_wakeword](#start-wakeword) (  )                                                                                         |
 
+## Signals
+
+### on_error ( ) {#on-error}
+
+No description provided yet.
+
+### on_stt_message (message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) {#on-stt-message}
+
+No description provided yet.
+
+### on_tts_message (message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) {#on-tts-message}
+
+No description provided yet.
+
+### on_tts_sound (sound: [AudioStreamMP3](https://docs.godotengine.org/de/4.x/classes/class_audiostreammp3.html)  ) {#on-tts-sound}
+
+No description provided yet.
+
+### on_wake_word (wake_word: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) {#on-wake-word}
+
+No description provided yet.
+
+## Constants
+
+
+### HASS_API = `<Object>` {#const-HASS-API}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}

docs/reference/lib--home_apis--hass_ws--handlers--auth.md

@@ -1,4 +1,5 @@
 # Auth
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -19,6 +20,20 @@
 | void    | [handle_message](#handle-message) ( message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )                                                                                                                      |
 | void    | [on_disconnect](#on-disconnect) (  )                                                                                                                                                                                                          |
 
+## Signals
+
+### on_authenticated ( ) {#on-authenticated}
+
+No description provided yet.
+
+## Constants
+
+
+### HASS_API = `<Object>` {#const-HASS-API}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}

docs/reference/lib--home_apis--hass_ws--handlers--integration.md

@@ -1,4 +1,5 @@
 # Integration
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -16,6 +17,16 @@
 | void    | [_init](#-init) ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) |
 | void    | [on_connect](#on-connect) (  )                                                  |
 
+
+
+## Constants
+
+
+### HASS_API = `<Object>` {#const-HASS-API}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}

docs/reference/lib--home_apis--hass_ws--hass.md

@@ -1,4 +1,5 @@
 # Hass
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -12,10 +13,10 @@
 | [connected](#connected)                     | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html)                   | `false` |
 | [devices_template](#devices-template)       | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)               |         |
 | [entities](#entities)                       | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html)       |         |
-| [entitiy_callbacks](#entitiy-callbacks)     | [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html)     |         |
+| [entitiy_callbacks](#entitiy-callbacks)     | [CallbackMap](/reference/CallbackMap.html)                                            |         |
 | [id](#id)                                   | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html)                     | `1`     |
 | [integration_handler](#integration-handler) | [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html)         |         |
-| [packet_callbacks](#packet-callbacks)       | [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html)     |         |
+| [packet_callbacks](#packet-callbacks)       | [CallbackMap](/reference/CallbackMap.html)                                            |         |
 | [request_timeout](#request-timeout)         | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html)                 | `10.0`  |
 | [socket](#socket)                           | [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) |         |
 | [token](#token)                             | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)               | `""`    |
@@ -47,6 +48,36 @@
 | void                                                                      | [update_room](#update-room) ( room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )                                                                                                                                                                              |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [watch_state](#watch-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) )                                                                                     |
 
+## Signals
+
+### on_connect ( ) {#on-connect}
+
+No description provided yet.
+
+### on_disconnect ( ) {#on-disconnect}
+
+No description provided yet.
+
+## Constants
+
+
+### AuthHandler = `<Object>` {#const-AuthHandler}
+
+No description provided yet.
+                
+
+
+### IntegrationHandler = `<Object>` {#const-IntegrationHandler}
+
+No description provided yet.
+                
+
+
+### AssistHandler = `<Object>` {#const-AssistHandler}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### LOG_MESSAGES: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#LOG-MESSAGES}
@@ -73,7 +104,7 @@ No description provided yet.
 
 No description provided yet.
 
-### entitiy_callbacks: [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html) {#entitiy-callbacks}
+### entitiy_callbacks: [CallbackMap](/reference/CallbackMap.html) {#entitiy-callbacks}
 
 No description provided yet.
 
@@ -85,7 +116,7 @@ No description provided yet.
 
 No description provided yet.
 
-### packet_callbacks: [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html) {#packet-callbacks}
+### packet_callbacks: [CallbackMap](/reference/CallbackMap.html) {#packet-callbacks}
 
 No description provided yet.
 

docs/reference/lib--stores--devices.md

@@ -1,4 +1,5 @@
 # Devices
+**Inherits:** [Store](/reference/lib--stores--store.html)
     
 
 
@@ -12,6 +13,16 @@
 
 
 
+## Constants
+
+
+### StoreClass = `<Object>` {#const-StoreClass}
+
+No description provided yet.
+                
+
+
+
 ## Method Descriptions
 
 ### clear ( ) -> void {#clear}

docs/reference/lib--stores--house.md

@@ -1,4 +1,5 @@
 # House
+**Inherits:** [Store](/reference/lib--stores--store.html)
     
 
 
@@ -19,6 +20,16 @@
 | void                                                                      | [clear](#clear) (  )                                                                                      |
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_room](#get-room) ( name: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
 
+
+
+## Constants
+
+
+### StoreClass = `<Object>` {#const-StoreClass}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### align_position1: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#align-position1}

docs/reference/lib--stores--settings.md

@@ -1,4 +1,5 @@
 # Settings
+**Inherits:** [Store](/reference/lib--stores--store.html)
     
 
 
@@ -18,6 +19,16 @@
 | void    | [_init](#-init) (  ) |
 | void    | [clear](#clear) (  ) |
 
+
+
+## Constants
+
+
+### StoreClass = `<Object>` {#const-StoreClass}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}

docs/reference/lib--stores--store.md

@@ -1,4 +1,5 @@
 # Store
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -20,6 +21,24 @@
 | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [save_local](#save-local) ( path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )   |
 | void                                                                      | [use_dict](#use-dict) ( dict: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
 
+## Signals
+
+### on_loaded ( ) {#on-loaded}
+
+No description provided yet.
+
+### on_saved ( ) {#on-saved}
+
+No description provided yet.
+
+## Constants
+
+
+### VariantSerializer = `<Object>` {#const-VariantSerializer}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### _loaded: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-loaded}

docs/reference/lib--utils--font_tools.md

@@ -1,4 +1,5 @@
 # FontTools
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -12,6 +13,10 @@
 
 
 
+
+
+
+
 ## Method Descriptions
 
 ### get_font_size (label: [Label3D](https://docs.godotengine.org/de/4.x/classes/class_label3d.html) , chars: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-font-size}

docs/reference/lib--utils--gesture--gesture.md

@@ -1 +1,2 @@
 # Gesture
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)

docs/reference/lib--utils--pointer--initiator.md

@@ -1,4 +1,5 @@
 # Initiator
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -15,6 +16,54 @@
 | ------------------------------------------------------------------- | -------------------------- |
 | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | [is_right](#is-right) (  ) |
 
+## Signals
+
+### on_press (type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html)  ) {#on-press}
+
+No description provided yet.
+
+### on_release (type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html)  ) {#on-release}
+
+No description provided yet.
+
+## Constants
+
+
+### CONTROLLER_LEFT = `0` {#const-CONTROLLER-LEFT}
+
+No description provided yet.
+                
+
+
+### CONTROLLER_RIGHT = `1` {#const-CONTROLLER-RIGHT}
+
+No description provided yet.
+                
+
+
+### HAND_LEFT = `2` {#const-HAND-LEFT}
+
+No description provided yet.
+                
+
+
+### HAND_RIGHT = `3` {#const-HAND-RIGHT}
+
+No description provided yet.
+                
+
+
+### GRIP = `0` {#const-GRIP}
+
+No description provided yet.
+                
+
+
+### TRIGGER = `1` {#const-TRIGGER}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### node: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#node}

docs/reference/lib--utils--pointer--pointer.md

@@ -1,4 +1,5 @@
 # Pointer
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -29,6 +30,16 @@
 | void    | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )                                                                      |
 | void    | [_ready](#-ready) (  )                                                                                                                                                                           |
 
+
+
+## Constants
+
+
+### Initiator = `<Object>` {#const-Initiator}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### click_point: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#click-point}

docs/reference/lib--utils--sample_hold.md

@@ -1,4 +1,5 @@
 # SampleHold
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -12,6 +13,10 @@
 
 
 
+
+
+
+
 ## Method Descriptions
 
 ### sample_and_hold (data: [PackedVector2Array](https://docs.godotengine.org/de/4.x/classes/class_packedvector2array.html) , sample_rate: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html)  ) -> [PackedFloat32Array](https://docs.godotengine.org/de/4.x/classes/class_packedfloat32array.html) {#sample-and-hold}

docs/reference/lib--utils--touch--collide.md

@@ -1,4 +1,5 @@
 # Collide
+**Inherits:** [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html)
     
 
 
@@ -21,6 +22,16 @@
 | void    | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )                                                                                                                                                                                |
 | void    | [_ready](#-ready) (  )                                                                                                                                                                                                                                                                                     |
 
+
+
+## Constants
+
+
+### Finger = `<Object>` {#const-Finger}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### bodies_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#bodies-entered}

docs/reference/lib--utils--touch--finger.md

@@ -1,4 +1,5 @@
 # Finger
+**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
     
 
 
@@ -11,6 +12,70 @@
 
 
 
+
+
+## Constants
+
+
+### THUMB_RIGHT = `0` {#const-THUMB-RIGHT}
+
+No description provided yet.
+                
+
+
+### INDEX_RIGHT = `1` {#const-INDEX-RIGHT}
+
+No description provided yet.
+                
+
+
+### MIDDLE_RIGHT = `2` {#const-MIDDLE-RIGHT}
+
+No description provided yet.
+                
+
+
+### RING_RIGHT = `3` {#const-RING-RIGHT}
+
+No description provided yet.
+                
+
+
+### LITTLE_RIGHT = `4` {#const-LITTLE-RIGHT}
+
+No description provided yet.
+                
+
+
+### THUMB_LEFT = `5` {#const-THUMB-LEFT}
+
+No description provided yet.
+                
+
+
+### INDEX_LEFT = `6` {#const-INDEX-LEFT}
+
+No description provided yet.
+                
+
+
+### MIDDLE_LEFT = `7` {#const-MIDDLE-LEFT}
+
+No description provided yet.
+                
+
+
+### RING_LEFT = `8` {#const-RING-LEFT}
+
+No description provided yet.
+                
+
+
+### LITTLE_LEFT = `9` {#const-LITTLE-LEFT}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### area: [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) {#area}

docs/reference/lib--utils--touch--touch.md

@@ -1,4 +1,5 @@
 # Touch
+**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
     
 
 
@@ -20,6 +21,16 @@
 | void    | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )                                                                                       |
 | void    | [_ready](#-ready) (  )                                                                                                                                                                                            |
 
+
+
+## Constants
+
+
+### Finger = `<Object>` {#const-Finger}
+
+No description provided yet.
+                
+
 ## Property Descriptions
 
 ### areas_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#areas-entered}

docs/reference/lib--utils--variant_serializer.md

@@ -1,4 +1,5 @@
 # VariantSerializer
+**Inherits:** [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html)
     
 
 
@@ -13,6 +14,10 @@
 
 
 
+
+
+
+
 ## Method Descriptions
 
 ### parse_value (value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html)  ) -> void {#parse-value}

docs/vendor-integration/home-assistant.md

@@ -0,0 +1,21 @@
+# Integration with Home Assistant
+
+This guide will help you install the Immersive Home integration into Home Assistant. The app will automatically detect the presence of the integration and will sync the room your headset is in with Home Assistant.
+
+![Integration inside Home Assistant](/img/ha-integration.png)
+
+## Installation
+
+1. Download the latest release from [GitHub](https://github.com/Nitwel/Immersive-Home/releases/latest/download/Integration.zip)
+2. Extract the zip file
+3. Copy the `immersive_home` folder into the `custom_components` folder of your Home Assistant instance
+4. Add the following line to your `configuration.yaml` file:
+
+```yaml
+immersive_home:
+
+```
+
+5. Restart Home Assistant
+
+If everything was done correctly, you should see the integration in the integrations panel of Home Assistant.