/Mobile-GamAR

Mobile GamAR is a mobile augmented reality application that allows users to conveniently and intuitively play virtual board and card games. With the aid of a mobile device, users can control a variety of game pieces for Poker and Jacks.

Primary LanguageC#

Mobile-GamAR

Explore the Docs 📖 View Demo 🎥 Report Bug 🐛 Request Feature 💻

Mobile GamAR Spashscreen

Mobile GamAR is a mobile augmented reality application that allows users to conveniently and intuitively play virtual board and card games. With the aid of a mobile device, users can control a variety of game pieces for Poker and Jacks.

Built With

Mobile GamAR was built with:

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

You will need to install the following software to run Mobile GamAR:

  • Unity - Version 2019.3.12f1 (Newer versions may work but untested).

You will need the following accounts set up:

You will need to print a variety of AR targets used in the project. These targets can be found here. The following image targets are used:

  • Stones
  • Tarmac
  • Vortex

NOTE: Image targets work best when kept straight and crease-free. It is best if the image targets are glued to a hard surface like cardboard.

Installation

  1. Clone the repository.
git clone https://github.com/samsilverman/Mobile-GamAR.git

  1. Create a Vuforia license key. Steps to do so can be found here.

  2. Add the license key to Unity. Specifically, in Window > Vuforia Configuration > App License Key add the license key from Vuforia.

  3. Set project build settings. Go to File > Build Settings.... From the Build Settings menu, select the iOS platform. Ensure that all the scenes are in the Scenes To Build window with the following order:

Scene Name Build Index
Scenes/MainMenuScene 0
Scenes/PlayingCardsScene 1
Scenes/JacksScene 2
  1. Build the project. Select Build And Run (you can save the build however you like). In XCode, build the project to your iOS device.

Usage

Currently, Mobile GamAR supports two games: cards and jacks. The primary means for interacting with the virtual objects is through the hand toolbar (vortex image target).

Hand Toolbar

The hand toolbar allows for the selection and manipulation of a variety of game pieces.

For more information, please refer to the Documentation.

Contribute

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

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

Contact

Sam Silverman - @sam_silverman - samuel.silverman@columbia.edu

Project Link: https://github.com/samsilverman/Mobile-GamAR

Acknowledgements

Mobile GamAR was a final project for the course COMS 4172: 3D User Interfaces and Augmented Reality taught by Prof. Steven K. Feiner.

Original Project Team: