Commit e800a34e authored by Mikko Lainio's avatar Mikko Lainio 🇺🇦
Browse files

update readme

parent 7308e921
Quantum physics library for Quantum Wheel game jam 2019
2019.02.11
Updated 2019.02.11
Requirements
============
......@@ -10,6 +10,9 @@ Requirements
Installation
============
!!! IMPORTANT: Make sure you run every python command within Python 3.7 environment. !!!
!!! This makes a difference if you have both Python 2 and Python 3 installed. !!!
Windows
-------
1. Install Python 3.7
......@@ -17,11 +20,16 @@ Windows
2. Unpack gym-stirap.zip
3. Initialize the Quantum Wheel library in Python
- cd gym-stirap
- python install_gym-stirap.py
3. Initialize the Quantum Wheel library in Python.
- Run python command:
python -m pip install ./
4. Set API compatibility level to .NET 4.x in Unity
- Edit/Project Settings/Player/Other Settings/Configuration/Api Compatibility Level
4. Install the unity package in Unity
5. Install the unity package in Unity
6. Open the demo scene in Plugins/QuantumWheel/Scenes and run.
Linux
-----
......@@ -34,9 +42,15 @@ Linux
2. Unpack gym-stirap.zip and cd gym-stirap
3. Initialize the Quantum Wheel library in Python
- python install_gym-stirap.py
run python command
python -m pip install ./
4. Set API compatibility level to .NET 4.x in Unity
- Edit/Project Settings/Player/Other Settings/Configuration/Api Compatibility Level
5. Install the unity package in Unity
4. Install the unity package in Unity
6. Open the demo scene in Plugins/QuantumWheel/Scenes and run.
OSX
---
......@@ -46,9 +60,17 @@ OSX
2. Unpack enclosed zip with the Python code to somewhere outside your unity project directory
3. Initialize the Quantum Wheel library in Python
- python install_gym-stirap.py
run python command
python -m pip install ./
4. Set API compatibility level to .NET 4.x in Unity
- Edit/Project Settings/Player/Other Settings/Configuration/Api Compatibility Level
5. Install the unity package in Unity
6. Open the demo scene in Plugins/QuantumWheel/Scenes and run.
4. Install the unity package in Unity
Troubleshooting
===============
......@@ -64,6 +86,7 @@ Troubleshooting
- Make sure you ran the install_gym-stirap.py python script which is required for initialization.
- Run script again
- RESTART UNITY
- Make sure the Python environment you're using is Python 3.7 and not something else.
Running builds made with Quantum Wheel plugin
......@@ -71,9 +94,10 @@ Running builds made with Quantum Wheel plugin
- Run steps 1-3
- You may include the gym-stirap folder/directory in your redistributable package, but Python3.7 still needs to be installed and the library still needs to be initialized.
Manual installation from repository
===================================
- git clone https://gitlab.utu.fi/matros/gym-stirap
- cd gym-stirap
- git checkout quantum_wheel
- python3.7 -m pip install -e ./
\ No newline at end of file
- python -m pip install -e ./
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment