Metaverse experience tailored for the visually impaired.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Acknowledgments

About The Project

Melvis is the successor to a prototype that demonstrated how a metaverse could be created for both the visually impaired and the sighted. It's purpose is to provide assistive tools to both identify and explain 3D scenes through auditory and haptic means. The aim is to enable visually impaired people to use any type of metaverse without the need for assistance from others.

It is based on the following technologies:

(back to top)

Getting Started

This guide will take you through the steps required to install and use Melvis. Be aware of the requirements that are needed to use Melvis.

Prerequisites

Melvis is built on top of node16 and it's dependencies are loaded via npm. The following instructions assume that node is installed and that your local development environment has access to npm. To upgrade to the latest version of npm, you can use the following command:

npm install npm@latest -g

Use the following command to check your node version:

node --version

Installation

1. Clone the repo

   git clone https://github.com/timondev/melvis.git

2. Install NPM packages

   cd melvis && npm install

3. Run the local deployment:

   npm run dev

(back to top)

Roadmap

• WebXR space
• Full support for assistive screen readers
• Support distance approximation algorithm

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to star the project! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License, Version 2.0. See LICENSE.txt for more information.

(back to top)

Acknowledgments

There are currently no acknowledgements.

(back to top)