From 8fd0d075e34ff256fb2b531a11322f7b0a1b1bd5 Mon Sep 17 00:00:00 2001
From: Haaris Iqubal <mdhaarisiqubal@icloud.com>
Date: Thu, 18 Jul 2024 23:11:54 +0200
Subject: [PATCH] Added ReadMe file

---
 README.md                   |  78 ++++++++++++++++++++++++++++++++++--
 detectivesherlock/.DS_Store | Bin 10244 -> 12292 bytes
 2 files changed, 74 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c65f31d..7ed4787 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
GIT binary patch
delta 2278
zcmZn(Xh~3DU|?W$DortDV9;P-VBlbY&;mRR3=C}y3<}&671U*!L5dg{7z`K~7?>Ft
z1Q-~K8B!Ta7>dh+i}EHGDo-|0VPR!tU|?XG+$|w1UcjKokjzlbP{2^ckk63inUkNK
zl#`#dvCx@)Gdl+h2dgRr1B2+~36jdndJM%3IShF)B@AH08P+o}FwFZ81`G_78>G@?
zP!%xBqAO5LDlaYoS;D};up_A;C$qT3z~CAq6Eh1d8#_BYJ2(4eU%@b4PEJnFcmav(
zYC|(49R*`!!&)7MYD*&n9R(9(v)Wot4pC)&>!A4ToZP(puE`e#<r%v{)=%b@{K)G0
z(PzH&<XWlB$vILya9+*iW~t<QP&nk|=cPl#iJifRA(J7Ap@<=op@^Xp)$w58>481>
zp8*8WR1@?`Y;Z<?d2mT$NolcDVo`K(M*ie@K^M~fR^QFQz<_3XW^x%c7#Z)tg7Ln9
zAT%I3IJvlac=`AR1cih}ghYkJ#6-j;B*mnpWu)Q-gp(4Jv(t<6OY>5k^K<fxoN`K2
zqtlBrQ-TW;lQZ+uBT7;$N`f=1QsV`Lz)I^8YJ*Z!;=p2Hp^(ag)OZ0AgaFt)_oCF)
zJg|ZOX=%l&B@syM$f(4M5V-OD#mPnaIXMCO#hE3U`FW8s#TohKo+YWdo_T5c@d83+
znW^Re1ts;F`FX`*sYS(^`FZgIXqqBoa}twMbNut1@=Hqcb0ZUriW2kEQ=KX!GL!T3
zAl~2yo12`U7f_T6GE>?911LTj7?d5nVGK~F0;g(ahzLkBtpUug=MVwY2!fF_BriWN
zRoNi`BF4$U!Jy0F%;3)u!H~;P!!Vg)KErB;Z44(Et}?u0_`}G>D8eYqsLyD@=*Z~B
z=))Mw7{?gTSio4wSjJcnF@gz{EkR5<5P`sq4GfAHv7eJ}7@VA+TL4PN)~B-mPnM9D
zW8=1FD(sP+Y$L5u4`Cj2#7s8@83>*B3mic9prtIdEW*Oz!;sIA&QOe+Ilws^Idj0(
zC6yP;L6as`b2vB`z->WuB?m(QLn1>mLpDPqLpnn$hHF7N2-&q5>IrA&$$o;Nq~~46
z?#ch8U09F*cb_jkIbTM6a-0kgoTnv=;SOYfP5vjNgkGTjWME)`djzC_h6U<B8Kud;
zWcel^lQCeOat~Cf8p^6pR*>a^^DHJa%F6SgxcQ!}j5KOeVE`pVSS>O6uB<E#oqSJL
z2E{oW3$qyOxfmE2#26eIiovyEE<+MS4nrk4zXmg8fJ=TH6(P7hU|<9#9+>+<8HNpR
zRtb7S1N#*oKMV{EYz&T*l>|k_h^p%hOmq}X3=N2=>plvaF+1K+-K-@f%BH#f=TA;K
z6>x4xaawMEiVL)=<p8UhoFSoL7<B+t)#c{9z~#8DnHU%tSV3N6V9?-ZU|?`%U_dl1
sHWt2Tp3JYJ%Lyu>4uDimw&9UxVPs(7n4F<9bMrLOl}x0$K@_VS08S=TrT_o{

delta 1024
zcmZokXbF&DU|?W$DortDU{GLSVBlbY&;mRY3&ketNlrG<VG(CwU|`S#sbgReU|=Z7
zNjD5m&d)8_c+re~;)DFn>>Ml{^&ojx20eySh7yKcgc^`mh8mTn3=9lNvbp&#E=f80
zNl*(px2qg;L|2hQKt(|Y#1&v0n(Dz6JA)oW8ACBcGDAK?3PUQ)p<p=%b}j}61~e5o
z9D<<=t7DK=xuh_pqPU2`0Awp0gCj#RLoq`tLkUB1Qh9L!)Ym(c3UV@wOAHLIF)}f;
zu(Gjpuyb&8Og<nTCd9$X!5J?gSzT>pU}mYKple|;*;Y=Pv3qi)oIGRC<OoGG<`wrf
zH&0X)Wn=A>y0>k|<kjl(P}X^M1?EEq3==2FPA(Ekotz=`k(Gggfph!hIN?%I%z^`Y
za-mS#WJeL<$w$PcG#PRx=-Pq9#fKr2A&H@gA(5eop%OV<)@m2*JD@U|T|$BFLg}3R
z11ghsCFJWF@~>O~`H+RdhasOKouL>du$dTy85kJga>&M=oG|yw4oG|>$s+<7n><R$
zGBq$TFih^0a)SEpf|N3xB|e#7T6i*xto-Cw89S)xKN;1@Z)JGkJd1i3h7g8Sj8qzb
z_&nInP&s5buLB1GIE}*f=H?^Zj7=WJ%~=Vcu;O6|1*L__*|I_cD8a?BL~e4Ttc(b<
zoq9TA$@^4}If5iW?&s)L?KrU)D!`9oI>UvH7mFALnL&0iFeq>{Ffh0>FbME$y!f4Y
dGQW;4Bg1499%T+DNcPs4oT4*xbA}2tGXM^*^S%H8

-- 
GitLab