Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/js13kgames/purplflow

purplFLOW - a js13kGames 2018 competition entry by @primedcore.
https://github.com/js13kgames/purplflow

2018 competition game html5 javascript js13k js13kgames js13kgames2018 offline optimization vr webxr

Last synced: 3 days ago
JSON representation

purplFLOW - a js13kGames 2018 competition entry by @primedcore.

Awesome Lists containing this project

README 

        
# Table of Contents

- [Description](#purplflow)

- [How to play](#how-to-play)

  - [Google Cardboard](#google-cardboard)

  - [Google Daydream](#google-daydream)

  - [Samsung Gear VR](#samsung-gear-vr)

  - [HTC Vive](#htc-vive)

  - [Oculus Rift](#oculus-rift)

  - [Don't have VR?](#no-vr)

- [Contributing](#contributing)

- [Releases](#releases)

- [Still need help?](#help)

- [Notice](#notice)



---

# purplFLOW

PurplFLOW is a VR action shooter game inspired by [SUPERHOT](https://superhotgame.com "Time moves when you move") made for the [js13kGames competition](https://js13kgames.com "Annual competition with plenty of prizes. Want to participate?") with the [A-Frame library](https://aframe.io "A-Frame") for WebVR developed by [Mozilla®](https://mozilla.org "Non-profit dedicated to protecting the Internet"). The Glitch project of purplFLOW is available [here](https://purplflow.glitch.me "The Glitch project for purplFLOW"), where you can play and remix the game into your own version.



Mozilla® is a registered trademark of the Mozilla Foundation.



---

# How to play

1. Open up [purplFLOW](https://purplFLOW.glitch.me "purplFLOW. plug play shoot.") on your phone, tablet or computer in the latest up-to-date version of either Chrome or Firefox (though VR might not be possible on a tablet!). Alternatively, you can download the latest release of purplFLOW, unzip it and open `index.html` located inside the `game/` folder ([don't know if you need to update?](https://updatemybrowser.org "Find out which browser version you have and update it if needed"))

2. Get your VR headset and set it up ([need help?](#help))

   - [Google Cardboard (or similar)](#google-cardboard)

   - [Google Daydream](#google-daydream)

   - [Samsung Gear VR](#samsung-gear-vr)

   - [HTC Vive](#htc-vive)

   - [Oculus Rift](#oculus-rift)

   - [Don't have VR?](#no-vr)



---

## Google Cardboard

3. Pair a gamepad or controller through Bluetooth with your device for a better experience (optional) ([how?](#pair-a-controller))

4. Enter VR mode by touching the VR headset icon in the bottom right corner of your device's screen

5. Plug your phone in the VR headset ([need help setting it up?](https://support.google.com/cardboard/answer/6295046?hl=en "Google Support Article"))

6. Put your headset on and have fun!



**Controls**



Look around using your headset and shoot by tapping on the screen, or on a button, if available ([if you pair a controller, you can move around and shoot with it!](#pair-a-controller)).



## Google Daydream

3. Enter VR mode by touching the VR headset icon in the bottom right corner of your device's screen

4. Plug your phone in the VR headset ([need help setting it up?](https://support.google.com/daydream/answer/7105598?hl=en "Google Support Article"))

5. Put your headset on and have fun!



**Controls**



Move and shoot using the Daydream controller; look around using your headset.



## Samsung Gear VR

3. Enter VR mode by touching the VR headset icon in the bottom right corner of your device's screen

4. Plug your phone in the VR headset ([need help setting it up?](https://support.oculus.com/guides/gear-vr/latest/concepts/gsg-a-hw-hardware-setup/#gsg-a-hw-hardware-setup "Oculus Gear VR Support Article"))

5. Put your headset on and have fun!



**Controls**



Move and shoot using the Gear VR controller and look around using your headset.



## HTC Vive

3. Connect your HTC Vive to your PC or laptop ([need help setting it up?](https://www.vive.com/eu/support/vive/category_howto/setting-up-for-the-first-time.html "HTC Vive Support Article"))

4. Enter VR mode by touching the VR headset icon in the bottom right corner of your device's screen

5. Put your headset on and have fun!



**Controls**



If you've set up the position tracking cameras, you can move and crouch freely with your body; otherwise, you can still move using your HTC Vive controllers. You can also shoot with them and you can look around using your headset.



## Oculus Rift

3. Connect your Oculus Rift to your PC or laptop ([need help setting it up?](https://support.oculus.com/guides/rift/latest/concepts/rgsg-1-sw-software-setup/#rgsg-1-sw-software-setup "Oculus Rift Support Article"))

4. Enter VR mode by touching the VR headset icon in the bottom right corner of your device's screen

5. Put your headset on and have fun!



**Controls**



If you've set up the position tracking cameras, you can move and crouch freely with your body, otherwise, you can still move using your Oculus Rift controllers. You can also shoot with them and you can look around using your headset.



## No VR

Don't worry, even if you don't have VR or a compatible headset, you can still play purplFLOW without a VR experience. On a desktop PC or laptop, you can use your keyboard and mouse to move, look around and shoot (with W, A, S, D keys, mouse and left mouse button). On mobile, if your phone or tablet has a gyroscope, you can look around by rotating the phone to have the whole 360° experience; otherwise, you can still move your view with your finger, and shoot by tapping on the screen.



## Pair a controller

1. Go to your device's settings

2. Enable Bluetooth

3. Activate the controller's pairing mode ([need help? [YouTube tutorial]](https://www.youtube.com/watch?v=mQxkk1VuCyE "Simple YouTube tutorial for pairing most controllers to a device"))

4. Select your controller from the available devices list

5. Now you have a paired controller!



Don't have a Bluetooth-enabled controller? If it has USB, you can still connect it to your device through USB with a Micro/Mini USB to USB cable and a special USB Port to Micro USB/USB Type C adapter, depending on your controller's and your device's ports. You can use a simple charger cable and find an adapter at a retail store or online.



**[Back to the Google Cardboard Setup](#google-cardboard)**



---

# Contributing

Found a bug? Spotted an error? Have an idea on how to improve the game? Want a feature added to purplFLOW? Feel free to [open an issue here](https://github.com/primedcore/purplflow/issues/new/choose "Open an issue to help speed up the game's development!"). *Make sure to fill it with detailed info* (i.e. how to reproduce the bug, what color you want the unicorns to be, whatever else you feel is necessary)*.* Feedback and questions are welcome at [email protected].



---

# Releases

The release versions of this game comply with [Semantic Versioning](https://semver.org "Semantic Versioning Specification regarding use and incrementing of version numbers"). Releases with the `-alpha` prefix denote versions which are *highly experimental* and *feature incomplete*. Releases with the `-beta` prefix denote *feature complete* versions which may contain *bugs*. **Development for purplFLOW continues after the submission deadline of the [js13kGames](https://js13kgames.com "Annual competition with plenty of prizes. Want to participate?") competition in the default** `master` **branch. To see the original submitted version of this game, visit the** `js13k` **branch of this repo, get the first release or go to the [game's entry page on the js13kGames website](https://js13kgames.com/entries/purplFLOW "See purplFLOW's entry page for the js13kGames competition").** Commit titles and descriptions are written in past tense to avoid confusion and simplify release changelogs.



---

# Help

If you still have trouble setting up your VR environment, or don't know what to do, visit https://webvr.info. If all else fails, or you have trouble playing purplFLOW, please contact me at [email protected] for support. I'll be happy to help! Consider [opening an issue](https://github.com/primedcore/purplflow/issues/new/choose "Open an issue to help speed up the game's development!") if the problem you have persists on multiple browsers or devices.



---

# Notice



VR is an immersive experience that can be intense at times. *Take frequent breaks* and interact with the real world to prevent symptoms of prolonged use like dizziness, blurred vision, disorientation, or lightheadedness. *Make sure you've read the safety warnings for your VR headset and that your surroundings are clear of potential dangers and obstacles when entering VR.* *Be aware that objects inside VR don't exist in the real world, so don't try to sit or place objects on them.*



**If, at any point, you notice a bug in VR which raises health risks (such as flashing images), please stop playing purplFLOW and [contact me immediately](#help).** If you have a history of seizures or epilepsy, consult your doctor before playing purplFLOW or entering VR. If you experience a seizure or epilepsy inside VR, please stop using your VR headset and see a doctor. *VR is not intended for use by children under 13.* A comfortable virtual reality experience requires *an unimpaired sense of motion and balance*. Please stop using your VR headset if you experience any *seizures*, *loss of awareness*, *eye strain*, *eye or muscle twitching*, *involuntary movements*, *altered, blurred, doubled or abnormal vision*, *dizziness*, *disorientation*, *impaired balance*, *impaired hand-eye coordination*, *panic or anxiety attacks*, *excessive sweating*, *increased salivation*, *nausea*, *lightheadedness*, *discomfort or pain in the head or eyes*, *drowsiness*, *fatigue* or *other serious symptoms* and consult your doctor. If symptoms of virtual reality exposure persist long after use, please see a doctor. The owner of purplFLOW is not responsible for improper or prolonged use of your VR headset, and any consequences that may result from it.



"purplFLOW" means the game purplFLOW, and all of the content available and presented in this repository at https://github.com/primedcore/purplFLOW/.



*Any of the trademarks, wordmarks, service marks, collective marks, design rights or similar rights that are mentioned, used or cited in this educational and informative material are the property of their respective owners. purplFLOW is neither endorsed by nor affiliated with any of the sites linked above or their owners, or any of the holders of any aforementioned rights. The sites linked above are referred to for educational and informative purposes only, and no guarantee is provided regarding them or their contents as they are not operated by the owner of purplFLOW, and may be changed or modified at any time by their respective owners without any notice. As such, purplFLOW, and the owner of purplFLOW cannot be held responsible for content or consequences of any kind that the user or visitor of the sites linked above may face regarding visiting or use of the aforementioned sites.*



**[Back to top](#table-of-contents)**