A gamified Virtual Reality theapeutic application, addresses attention skills on various levels. The gameplay consists of a visual target tracking exercise that is designed to address and measure the various variables of attention.
Uncle Noah is a nice old man, living by himself in the neighborhood. Since heβs living alone, he usually needs help in his everyday activites. He does fishing, farming, growing fruits, and writes books to earn a living.
Ellie is a fairy living in the neighborhood. One evening, she saw Uncle Noah while he was working on his garden and she talked to him. When she got to know that he was living and working all by himself, she decided that sheβd pass by every day to help him. Ellie has invited the you to join her in helping Uncle Noah by unpacking his tools or collecting his objects.
The gameplay occurs in three unique environments. Each is composed of a round track on which the player shall reveal hidden items with the help of Ellie that are then collected. Uncle Noah is always present in the environments on the side doing an idle animation, and the items that the player and Ellie find are collected in a container that lies beside Uncle Noah. The three environments are:
- Garden; and the objective is to collect fruits and vegetables
- Beach; and the objective is to collect fish and fishing tools
- Library; and the objective is to collect letters
- A-Frame
- HTML, CSS, JavaScript
node v14.17.2
npm v6.14.13
- Clone the repository
git clone https://github.com/vrapeutic/EllieTale-WebXR.git
cd EllieTale-WebXR
- Install dependencies
npm install
- Run the project
npm run dev
- Go to the localhost URL specified in the terminal
- Congrats! You're now running the project locally! π
docker v20.10.1
- Clone the repository
git clone https://github.com/vrapeutic/Ellie-Tale.git
- Go to the repo's directory
cd Ellie-Tale
- Run
docker pull yahyaalaa/Ellie-tale-webxr:tag
to pull the latet Docker image from our DockerHub public repository, where you will find our availabletags
- Run
docker run -d -p YOUR_PREFERRED_PORT:3000 --name Ellie-tale --mount type=bind,source="$(pwd)",target=/webxr-code yahyaalaa/Ellie-tale-webxr:tag
command to run the Docker image on your local machine, and at the same time mount the working directory, to apply changes to the image on the fly - Choose your preferred port in order to run the app on local host
- Go to the localhost:YOUR_PREFERRED_PORT to check your new code modifications
- Hooray! You've got your Docker image-based local development environment ready!
- Go to Glitch platform
- Create an account if you don't already have one
- On your dashboard, then click New project, then choose the Import from GitHub option
- Paste the repo's full url, then click Ok
- You're ready to go!
If you are going to be using a VR Headset, then we recommend trying the app (either the hosted version or on Glitch) on the Oculus Browser.
For local development and testing, modern browsers could be used, where mouse and keyboard interactions will be the main source of interaction with the VR environment.
First off, thanks for taking the time to contribute! You can check out our contribution guidelines from this link. Please note that this project is released with a Contributor Code of Conduct, which can be found here. By participating in this project you agree to abide by its terms.
Thanks goes to these wonderful people (emoji key):
Yahya Alaa π π€ π π§βπ« π |
hadeergamal1 π π» π π¨ π€ π§ |
Ahmad Al-Kabbany πΌ π π§βπ« π |
This project follows the all-contributors specification. Contributions of any kind welcome!