Skip to content

AfonsoBatista7/metaverse-unity-vr-template

Repository files navigation

Contributors Forks Stargazers Issues License


Metaverse Unity VR Template

A comprehensive Unity VR template for metaverse projects!
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot, may be ani-gif

This project is designed to provide a comprehensive Unity VR template for metaverse projects. It aims to streamline the development process and provide a solid foundation for creating immersive VR experiences.

(back to top)

Built With

This section lists the major frameworks/libraries used to bootstrap the project. Here are a few examples:

  • Unity
  • VRToolkit
  • Oculus

(back to top)

Features

This section lists the features that have been implemented and those that are planned for the future. Use the following format:

  • Basic VR Setup
  • Multiplayer Support

Legend:

  • - Completed
  • - In Progress

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Hardware:

  • VR Headset (Oculus, HTC Vive, etc.)

Software:

  • Unity 2022.3+
  • Oculus Integration

Extra:

  • Internet access

Installation

Below is an example of how you can instruct your audience on installing and setting up your app.

  1. Clone the repo
    git clone https://github.com/AfonsoBatista7/metaverse-unity-vr-template.git
    cd metaverse-unity-vr-template
  2. Open the project in Unity
  3. Install required packages via Unity Package Manager
  4. Configure your VR headset or use XR Device Simulator in Unity settings
  5. Build and run the project

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation For development documentation, please refer to the Documentation

(back to top)

Roadmap

  • Basic VR Setup (2024)
  • Add Multiplayer Support

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. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Task Branch (git checkout -b task-my-awesome-task)
  3. Commit your Changes (git commit -m 'Add some thing that you did.')
  4. Push to the Branch (git push origin task-my-awesome-task)
  5. Open a Pull Request from task-my-awesome-task to dev branch. a. Please include a summary of the changes you made. b. Include screenshots or gifs if applicable. c. Include relevant links to issues or documentation. d. Assign to yourself e. Request a review from the project maintainer(s)

NOTES:

  • Please use the following naming convention for branches:

a. (task) - for tasks: git checkout -b task-my-awesome-task b. (feature) - for new features: git checkout -b feature-my-amazing-feature c. (bug) - for bug fixes: git checkout -b fix-my-awesome-fix

Top contributors:

contrib.rocks image contrib.rocks image

(back to top)

License

Distributed under the GPL-3 License. See LICENSE.txt for more information.

(back to top)

Contact

Afonso Batista - afonsobatista13@gmail.com Pedro Antunes - pedrodsantunes@gmail.com

Project Link: https://github.com/AfonsoBatista7/metaverse-unity-vr-template

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Generated from gafda/example-repo