diff --git a/README.md b/README.md index 6910ca6..fb54e29 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,72 @@ ## Cellulo-lua Bachelor Project - see [report.pdf](/report.pdf) The purpose of this project is to develop a virtual reality experience to explore human behaviour within a swarm, using the Oculus Quest VR headset and Cellulo robots developed by the Computer-Human Interaction in Learning and Instruction (CHILI) lab at EPFL. ### Installing LÖVR This project uses the LÖVR framework, which needs to be installed on the desired platform to run. *Note that if running on an Android platform such as the Oculus Quest, LÖVR only needs to be installed on the headset, not the computer where you are editing the project.* #### Linux ``` git clone https://github.com/bjornbytes/lovr git submodule init git submodule update cd lovr mkdir build cd build cmake .. cmake --build . ``` #### Other platforms (Windows, macOS, Android) See [LÖVR downloads page](https://lovr.org/downloads) for official builds of the framework. ### Launching Run with `lovr .` to run on the local development machine. #### Android To run on a remote Android platform (e.g. Oculus Quest), plug the device into the computer and install the LÖVR apk (`adb install lovr.apk`) Once installed, you can push local files to the LÖVR game source folder on the Android device. This project uses the [lodr](https://github.com/mcclure/lodr) library to automatically restart the app when a file is modified. -Navigate to the root of the project and run `watch adb push --sync . /sdcard/Android/data/org.lovr.test/files/.lodr`. The `watch` command will automatically look for changes locally every few seconds. To push files only once, remove it. +Navigate to the root of the project and run `watch adb push --sync . /sdcard/Android/data/org.lovr.cellulo/files/.lodr`. The `watch` command will automatically look for changes locally every few seconds. To push files only once, remove it. ### Testing [*luaunit*](https://github.com/bluebird75/luaunit) is used for unit tests. LÖVE needs to be installed. -Navigate to the root of the project and run with `love test` \ No newline at end of file +Navigate to the root of the project and run with `love test` + +#### Setting on the Quest: + +1. Enable developer mode on the app. +2. sudo adb kill-server +3. sudo adb start-server +4. Adb devices (on the quest you should authorize) +5. adb install lovr-cellulo.apk +(if error during installing-> change cable) [it didn't work with the cable of the quest] +6. (you have to be in the folder celulo-lovr): + watch adb push --sync . /sdcard/Android/data/org.lovr.cellulo/files/.lodr +7. 3 apks should be installed to connect to cellulo (can be found in apk folder): + - QuestAppLauncher so that we can launch 2D apps + - Cellulo_robot_pool_service.apk : service to launch pool + - Cellulo_robot_pool_gui.apk: pool gui to connect to cellulo +8. On the Quest the order the QuestAppLaunch is Library-> Unknown Sources -> QuestAppLauncher. +9. Then go to tab 2D you will see both cellulo_pool apks. +10. Launch cellulo_pool_service and click on start service +11. Launch cellulo_pool_gui and scan and connect to the robot +12. You can quit by going to the pressing menu on the joystick -> library-> cellulo.lovr.apk + + + diff --git a/apk/QuestAppLauncher.apk b/apk/QuestAppLauncher.apk new file mode 100644 index 0000000..af80aaa Binary files /dev/null and b/apk/QuestAppLauncher.apk differ diff --git a/apk/cellulo_robot_pool_gui.apk b/apk/cellulo_robot_pool_gui.apk new file mode 100644 index 0000000..de39939 Binary files /dev/null and b/apk/cellulo_robot_pool_gui.apk differ diff --git a/apk/cellulo_robot_pool_service.apk b/apk/cellulo_robot_pool_service.apk new file mode 100644 index 0000000..fd5149f Binary files /dev/null and b/apk/cellulo_robot_pool_service.apk differ diff --git a/apk/lovr-cellulo.apk b/apk/lovr-cellulo.apk new file mode 100644 index 0000000..73531e2 Binary files /dev/null and b/apk/lovr-cellulo.apk differ