diff --git a/README.md b/README.md index c65f31dd319859818125dfb99e7e8ac56e3b3c7a..7ed4787beeb3128b512f3f92d51564680625364e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,77 @@ # Welcome to Stabilio project for DGS -This is repository is project based on Stabilio project. -## Link -[Notion - Story](https://www.notion.so/Gamified-Project-8b9e59d481244f9e8d4d449933131a67?pvs=4) +The Unity Game Project! This is a comprehensive guide to help you get started with our game developed in Unity. Follow the instructions below to set up and run the project on your local machine. -> Last updated 05/12/24 \ No newline at end of file +## Table of Contents + +- [Introduction](#introduction) +- [Features](#features) +- [Requirements](#requirements) +- [Getting Started](#getting-started) + - [Clone the Repository](#clone-the-repository) + - [Install Unity](#install-unity) + - [Open the Project](#open-the-project) + - [Build and Run](#build-and-run) +- [Contributing](#contributing) +- [Copyright and Usage](#copyright-and-usage) +- [Link](#link) + +## Introduction + +This is a Unity-based game project showcasing Detective Sherlock game which is a Gamification approach to build a help user with adaptation process for Stabilo Pen Machine Learning. The project includes all the necessary assets and scripts to run the game as intended. + +## Features + +- **Feature 1:** Ability to connect the pen with app +- **Feature 2:** Able to play whole story line and finally have to guess who's the thief. + +## Requirements + +To run this project, you'll need the following: + +- **Unity Version:** [Unity version—2023.2.19f1] +- **Kathy Version:** [version- 0.9.0] +- **Operating System:** [OS— Windows 10/11, macOS 10.15+] +- **Additional Software:** [Visual Studio] +- **Android Version:** [Android 11 or above] + +## Getting Started + +Follow these steps to get up and running with the project: + +### Clone the Repository + +```bash +git clone https://gitlab.cs.fau.de/gamis-projekt/unity.git +cd repository-name +``` +### Install Unity +Download and install Unity Hub from Unity's official website. +Open Unity Hub and sign in with your Unity account. +Install the required Unity version specified in the ProjectSettings/ProjectVersion.txt file of the repository. +### Open the Project +Launch Unity Hub. +Click on the "Add" button and navigate to the cloned repository directory. +Select the project folder and click "Open." +### Build and Run +In Unity Editor, go to File > Build Settings. +Select your target platform (e.g., PC, Mac, Linux Standalone). +Click on Build and choose a location to save the built game. +Once the build process is complete, you can run the game from the output directory. + +### Copyright and Usage + +The assets used in this project, including but not limited to textures, models, and animations, were generated using generative AI tools, such as Microsoft Doll-E 3. We have ensured that no copyrighted materials or proprietary content were copied or used without permission. + +We have made every effort to create original content or use AI-generated content that does not infringe on existing copyrights. If you believe any part of this project violates copyright laws, please contact us so we can address the issue promptly. + +### Link +[Notion - Story](https://www.notion.so/Gamified-Project-8b9e59d481244f9e8d4d449933131a67?pvs=4) : Check our story building phase + +[Figma - Hi-Fi Design](https://www.figma.com/design/qGGNBgmsXfeXppp8BEBvj2/DetectiveGame?node-id=5-38&t=X64QivsM0dwhPmgZ-1) : Check this out for High Fidelity design. + +[Figma - Click Dummy](https://www.figma.com/proto/qGGNBgmsXfeXppp8BEBvj2/DetectiveGame?node-id=163-1337&starting-point-node-id=163%3A1337&t=lMAHCLhZGD6ErRoe-1) : Check this out for click dummy design of this project. + +Thank you for checking out our Unity game project! We hope you like it and further more explore it. + +> Last updated 07/18/24 \ No newline at end of file diff --git a/detectivesherlock/.DS_Store b/detectivesherlock/.DS_Store index 97fedc65b48da2362e5a66ee7ee3331d2bb74a54..07858f29b0db9b9bfe26404c583ec9e4d68ad45b 100644 Binary files a/detectivesherlock/.DS_Store and b/detectivesherlock/.DS_Store differ