# mechahamster

**Repository Path**: midismallyue/mechahamster

## Basic Information

- **Project Name**: mechahamster
- **Description**: Mecha Hamster is a game where you roll through customizable environments that you can share with your friends.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

MechaHamster    {#mechahamster_readme}
======

[MechaHamster][] is a game about guiding a futuristic hamster ball through dangerous space mazes,
create mazes of their own, and share them with friends.  Can you guide Major Hammy D. Hamster to
safety?

## Motivation

[MechaHamster][] serves as a demonstration, sample, and reference for integrating
[Firebase][] with the [Firebase Unity SDK][], and [Daydream][] with the [Google VR SDK for Unity][]
into a game project.

## Overview

MechaHamster demonstrates the following concepts:

   * Mobile and [Daydream][] play modes.
   * [Firebase Analytics][] to measure various aspects of user behavior.
   * [Firebase Authentication][] to associate user generated content with users.
   * [Firebase Realtime Database][] to store map and user data in addition to sharing content.
   * [Firebase Cloud Messaging][] to allow game admins to send push notifications which inform users
     of new map content.
   * [Firebase Crashlytics (Beta)][] to capture crashes in game play and help
     developers diagnose and fix issues.
   * [Firebase Remote Config][] to allow game admins to run experiments on game data without
     redeploying a new build of the game.
   * [Firebase Cloud Storage][] to upload and download replay data of the best playthrough shared by
     the players in each level. (Disabled by default)
   * [Firebase Cloud Function][] to limit number of scores in Database and remove unreferenced
     replay data from Storage.
   * [Firebase Test Lab][] to allow developers to test their game across a wide variety of hardware
     and device configurations at once.
   * [Firebase CLI][] to allow developers to deploy configurations and Cloud Function to Firebase
     project through console commands.

## Downloading

[MechaHamster][] source code can be downloaded from [Github][].

> If cloning locally using `git clone`, be sure to use the `--recurse-submodules` flag
> to ensure required scripts from submodules are present.

And download the game to your mobile device from the AppStore and Google Play Store

<a href="https://itunes.apple.com/us/app/mechahamster/id1286046770?mt=8&ign-mpt=uo%3D4">
  <img src="docs/img/app_store_badge.png" width="134px" alt="AppStore"/>
</a>
<br>
<a href="https://play.google.com/store/apps/details?id=com.google.fpl.mechahamster&hl=en">
  <img src="docs/img/google_play_badge.png" width="150px" alt="PlayStore"/>
</a>

## Building

   * Open the project in at least [Unity 5.6 beta][], this is required for the
     [Google VR SDK for Unity][].
   * Download the [Firebase Unity SDK][] and unzip.
   * Import the following plugins - using `Assets > Import Package > Custom Package` menu item -
     from the [Firebase Unity SDK][]:
      * FirebaseAnalytics.unitypackage
      * FirebaseAuth.unitypackage
      * FirebaseCrashlytics.unitypackage (Beta)
      * FirebaseDatabase.unitypackage
      * FirebaseMessaging.unitypackage
      * FirebaseRemoteConfig.unitypackage
      * FirebaseStorage.unitypackage
   * Select a target platform (iOS or Android) using the `File > Build Settings` menu option.
   * [Add Firebase to your app][]. For more information see [Building MechaHamster][].
   * Wait for the spinner (compiling) icon to stop in the bottom right corner of the Unity status
     bar.
   * Finally, select the `File > Build Settings` menu option then click `Build and Run`.

> [MechaHamster][] currently only works with .NET 3.x. If [Firebase Unity SDK][] version is 5.4.0 or
> above, please import plugins from `dotnet3` folder. And make sure `Scripting Runtime Version` in
> `Edit > Project Settings > Player` is set to .NET 3.x, ex. `Stable (.NET 3.5 Equivalent)` in Unity
> 2017

## Documentation
For more information about MechaHamster see [MechaHamster Document][]
To contribute the this project see [CONTRIBUTING][].

  [Add Firebase to your app]: https://firebase.google.com/docs/unity/setup
  [Android]: https://www.android.com/
  [CONTRIBUTING]: https://github.com/google/mechahamster/blob/master/CONTRIBUTING.txt
  [GitHub]: https://github.com/google/mechahamster/
  [Google]: https://google.com
  [Firebase]: https://firebase.google.com/docs/
  [Daydream]: https://developers.google.com/vr/daydream/overview
  [Google VR SDK for Unity]: https://developers.google.com/vr/unity/
  [MechaHamster]: https://github.com/google/mechahamster/
  [Firebase Unity SDK]: https://firebase.google.com/docs/unity/setup
  [Unity 5.6 beta]: https://unity3d.com/unity/beta]
  [Firebase Realtime Database]: https://firebase.google.com/docs/database/
  [Firebase Analytics]: https://firebase.google.com/docs/analytics/
  [Firebase Authentication]: https://firebase.google.com/docs/auth/
  [Firebase Cloud Messaging]: https://firebase.google.com/docs/cloud-messaging/
  [Firebase Crashlytics (Beta)]: https://firebase.google.com/docs/crashlytics/
  [Firebase Remote Config]: https://firebase.google.com/docs/remote-config/
  [Firebase Cloud Storage]: https://firebase.google.com/docs/storage/
  [Firebase Cloud Function]: https://firebase.google.com/docs/functions/
  [Firebase Test Lab]: https://firebase.google.com/docs/test-lab/
  [Firebase CLI]: https://firebase.google.com/docs/cli/
  [MechaHamster Documentation]: https://google.github.io/mechahamster/
  [Building MechaHamster]: https://google.github.io/mechahamster/mechahamster_guide_building.html