alexandru.stanciu/immersive-home
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

add file structure to readme

Browse Source
This commit is contained in:
Nitwel 2023-11-05 15:27:57 +01:00
parent ab1ff4d8b1
commit 4592e011d6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -31,6 +31,20 @@ Communication with the Smart Home Environment is done using the `HomeAdapters` g
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
```
.
├── 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)
│ └── ui (User Interface Scenes and related files)
└── lib (Code that is global or shared across scenes)/
├── globals (Globally running scripts)
└── home_adapters (Code allowing control smart home entities)
```
### Home Adapters
The `HomeAdapters` global allows to communicate with different backends and offers a set of fundamental functions allowing communication with the Smart Home.