README.md 4.07 KB
Newer Older
SimonP's avatar
SimonP committed
1
2
3
4
The Main Repository for the Games in Concert Unity Project.

Games in concert is a SNF funded research project exploring the possibilities and implications of collaborative creativity in virtual environments.

SimonP's avatar
SimonP committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
To Run the Project you need to clone it, open the GicNetworkedGamesInConcert_SeparateTerrain scene and press play.

# Games In Concert (Unity Project)

Games in concert is a SNF funded research project exploring the possibilities and implications of collaborative creativity in virtual environments.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

To sucessfully run the Unity project the following dependencies have to be installed.
VR Mode is based on using a HTC Vive Headset and controllers.

* [Leap Motion Unity Library (Core Assets)](https://developer.leapmotion.com/unity/#116)
SimonP's avatar
SimonP committed
21
22
* + Hands Module
* + Leap Motion Interaction Engine Module
SimonP's avatar
SimonP committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

From the Asset Store
* [Steam VR](https://assetstore.unity.com/packages/templates/systems/steamvr-plugin-32647) - The SteamVR Extention
* [TextMeshPro](https://assetstore.unity.com/packages/essentials/beta-projects/textmesh-pro-84126) - To display UI texts propperly
* [OSC simpl](https://assetstore.unity.com/packages/tools/input-management/osc-simpl-53710) - For OSC communication with Max/MSP
* [Squiggle](https://assetstore.unity.com/packages/tools/utilities/squiggle-21970) - If you wish to use the provided data collection scripts (works without)

If you do not wish to use OSCSimpl you can use one of the libraries below, However you`ll have to rewrite the OSCManager.cs script accordingly

* [UnityOSC](https://github.com/thomasfredericks/UnityOSC) - By ThomasFredericks
* [UnityOSC](https://github.com/jorgegarcia/UnityOSC) - By Jorge Garcia

### Installing

To Get the Project running: 
* Clone this repo (or download it).
* Install All Dependencies.
* Open the "GicNetworkedGamesInConcert_SeparateTerrain" scene found in _Scenes.
* Add that scene and the Bright and Dark terrain Scenes to your build settings.

You should now have a working scene wothout any scripting errors.

## Running the Scene

### Setup
* Find the _Managers GameObject
SimonP's avatar
SimonP committed
49
50
* Select which role you want to play and which terrain you want to use.
* If you have no VR headset check the Mouse Mode checkbox as well.
SimonP's avatar
SimonP committed
51
52
53
54
55
56
57
58
* Hit the play button.

### How to play

* Use nubers 1-4 to change your role ingame
* Navigation can be done using standard wsad and mouse or by using the Vive Controllers (Touchpad klick).

* First Create an atom by opening the bagpack (Click on the ui or hit B on your keyboard)
SimonP's avatar
SimonP committed
59
* Grab one and drag it into the scene by using the "grab" buttons. (Mouse: Right-Click, ViveController: Grab)
SimonP's avatar
SimonP committed
60
* Now you can create music depending on your role.
SimonP's avatar
SimonP committed
61
62
63
64
65
66
67

* **Trees:** Point to the floor and use the "action" button (Mouse: LeftClick, ViveController: Trigger)
* You can move the trees by grabbing the lower part of its cage.
* You can modify the trees by grabbing the upper part of its cage.

* **Paint:** Point towards the wall arround you and use the action button to paint.
* Use the UI to change the parameters of your stroke and paint modes.
SimonP's avatar
SimonP committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

## Authors

* **Simon Pfaff** - *Concept, Framework and Shaders* - [Bleep-O-Matic](http://www.bleep-o-matic.com)
* **Olav Lervik** - *Concept & Audio Programming* - [Homepage](http://olavlervik.com/)
* **Reto Spoerri** - *Concept & Input & Networking* - [Homepage](http://www.ludic.ch/)

## License

This project is licensed under the CC BY-SA 4.0 License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* [ProceduralToolkit](https://github.com/Syomus/ProceduralToolkit) - An awesome framework for procedural content generation in Unity by Daniil Basmanov. Thanks!
* [InverseKinematics](https://assetstore.unity.com/packages/tools/animation/inverse-kinematics-1829) - An very nice free IK solver by Jose (Dogzerx) Díaz. Thanks!
* [Unity UI Extensions](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions) - This should be standard in Unity. Thanks guys!