Skip to content

Devon-Wayman/Lest-We-Forget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lest-We-Forget

Contributors Forks Stargazers Issues MIT License LinkedIn


Product Name Preview

An immersive VR experience to take you back to a dark era from not so long ago.
Report Bug · Request Feature

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

About The Project

Lest We Forget has been in development for over 6 years. What started as a simple AR app made in my free time would later become a much larger scale project.

AR app preview

A screen grab from a video my mom took of the initial AR app test

When I was able to have access to VR equipment for the first time in my life via my university, I realized first-hand the power VR held when it came to increasing user immersion in a variety of situations.

Between classes, projects, study hours and sleeping, I found myself researching VR

The major goals of this application:

  • Teach a variety of ages about the WWII era
  • Increase people's appreciation of history through the use of modern tech
  • Allow those that may be unable to have access to museums an alternate method of learning

A list of commonly used resources in which I have obtained plethora of information are listed in the acknowledgements below.

Built With

Getting Started

Prerequisites

Please ensure you have one of the supported VR headsets in order to interact with the application:

  • Oculus
  • Other device support coming soon

Usage

Lest We Forget can be used as a teaching tool to educate the general public about a period in history that has since only been taught via books, films, and television documentaries. With the ability to enable parental controls, people of all ages can enjoy

Roadmap

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

Contributing

Making contributions to the project via the open source community not only helps with taking some of the weight off, but also helps myself as well as others who view the repo in learning new methods of solving problems, and inspires others to move forward with their ideas. Any contribution to the project made is highly appreciated! Whether it be a bug fix, feature addition, or anything else you believe would enhance the user's experience.

PLEASE NOTE:

Please submit one feature or bug fix per PR. Having a multitude of refactored code submitted all at once may present problems in the future so for the time being we ask that each PR have one main fix focused on. Also pleasre enjsure you have Unity version 2020.3.5f1 installed as to not cause merge conflicts with the ProjectSettings preferences. Thank you in advance :)
  1. Fork the Project
  2. Create your Feature Branch . If you are contributing a new feature, please have your branch name begin with "feature", followed by a forward slash and a basic name description. Example: (git checkout -b feature/your-new-feature) . Same goes for a bug fix. Example: (git checkout -b bugfix/your-bug-fix)
  3. Commit your Changes (git commit -m 'Basic description here')
  4. Push to the Branch you created
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Devon Wayman - @dway115 - [email protected]

Project Link: https://github.com/Devon-Wayman/Lest-We-Forget

Acknowledgements

Special thanks to the following resources for their vast amount of information they have given to the public

Also special thanks to my friends and family who have assisted in the applications development and driven me to keep going:

  • Jordan W.
  • Peter C.
  • Austin C.
  • Mom
  • Dad