# Study Platform Documentation


## SHiNE-Framework

Welcome to V-SHiNE: Virtual Smart Home with iNtelligent and Explainability Features!

- [Introduction](https://exmartlab.github.io/SHiNE-Framework/index.md): Welcome to V-SHiNE: Virtual Smart Home with iNtelligent and Explainability Features!

### search

- [Search the documentation](https://exmartlab.github.io/SHiNE-Framework/search.md)

### architecture

The V-SHINE Study Platform is a distributed web application designed for conducting smart home simulation research. The architecture employs real-time communication, modular services, and flexible data storage to support interactive research studies.

- [V-SHINE Platform Architecture](https://exmartlab.github.io/SHiNE-Framework/architecture.md): The V-SHINE Study Platform is a distributed web application designed for conducting smart home simulation research. The architecture employs real-time communication, modular services, and flexible data storage to support interactive research studies.

### game-config

To configure the game, both JSON files game.json and explanation.json is required in the folder platform/src/*.

- [Configuration](https://exmartlab.github.io/SHiNE-Framework/game-config.md): To configure the game, both JSON files game.json and explanation.json is required in the folder platform/src/*.

#### database

Introduction

- [Database](https://exmartlab.github.io/SHiNE-Framework/game-config/database.md): Introduction

#### explanation_engine

Inroduction

- [Explanation Engine](https://exmartlab.github.io/SHiNE-Framework/game-config/explanation_engine.md): Inroduction

#### game_schema

The game.json file defines the full structure of a smart home simulation used in our game-based studies. It coordinates all key components that drive user experience, system behavior, and experimental logic.

- [Game Config Schema](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema.md): The game.json file defines the full structure of a smart home simulation used in our game-based studies. It coordinates all key components that drive user experience, system behavior, and experimental logic.
- [Devices](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/devices.md): Introduction
- [Environment](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/environment.md): Temporal Configuration of the Simulation Environment:
- [Interacting with Devices](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/interaction_types.md): Introduction
- [Rules](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/rules.md): Inroduction:
- [Tasks](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/tasks.md): Introduction
- [Walls](https://exmartlab.github.io/SHiNE-Framework/game-config/game_schema/walls.md): Introduction

### getting-started

This guide helps you understand the platform architecture and create your first smart home study. After completing the Installation, you're ready to build your first interactive smart home scenario.

- [Getting Started](https://exmartlab.github.io/SHiNE-Framework/getting-started.md): This guide helps you understand the platform architecture and create your first smart home study. After completing the Installation, you're ready to build your first interactive smart home scenario.

### installation

This guide covers the installation requirements and setup process for the V-SHINE Study Platform.

- [Installation](https://exmartlab.github.io/SHiNE-Framework/installation.md): This guide covers the installation requirements and setup process for the V-SHINE Study Platform.

### scenario

This section contains example scenarios demonstrating how to configure and implement smart home simulation studies using the V-SHiNE platform.

- [Scenarios](https://exmartlab.github.io/SHiNE-Framework/scenario.md): This section contains example scenarios demonstrating how to configure and implement smart home simulation studies using the V-SHiNE platform.

#### default-scenario

Introduction

- [Default Scenario](https://exmartlab.github.io/SHiNE-Framework/scenario/default-scenario.md): Introduction

#### scenario-2

Introduction

- [CIRCE Scenario](https://exmartlab.github.io/SHiNE-Framework/scenario/scenario-2.md): Introduction

### testing

The V-SHINE Study Platform employs a comprehensive test suite built with Vitest to ensure reliability across all critical components of the smart home simulation platform.

- [Test Suite Documentation](https://exmartlab.github.io/SHiNE-Framework/testing.md): The V-SHINE Study Platform employs a comprehensive test suite built with Vitest to ensure reliability across all critical components of the smart home simulation platform.