Skip to content

Latest commit

 

History

History
151 lines (130 loc) · 8.59 KB

README.md

File metadata and controls

151 lines (130 loc) · 8.59 KB
Raw

Multimodal Fantasy Game

6.835 Final Project

Setup and Running Instructions

Requirements:

Python Installations

Replace pip install ... and python ... commands in the below instructions depending on your installation as necessary.

  1. Install PyAudio:
  2. Install other requirements from requirements.txt: pip install -r requirements.txt

Starting the Game

  1. Plug in Leap Motion Controller (make sure it works using the Leap visualizer)
    • Make sure in the Leap Motion Control Panel, "Allow Background Apps" is checked.
  2. Start app.py from the recognizer/ directory:
    • cd recognizer and then python app.py
  3. Make sure the Flask app is running at http://127.0.0.1:5000/ (which should just print "Hello, world!")
    • Make sure that "Recorder ready" is printed in the terminal before proceeding (if you do not reach this point, check the Troubleshooting section below)
  4. Navigate to game/Builds/ (i.e. using File Explorer) and run Kalpana.exe
  5. To quit the game, press Esc twice at any point in-game.

Playing the Game

Instructions are provided on the HOW TO PLAY screen in-game, but here are a few additional notes:

  • This is a game where you learn and practice spells. Say "Spell Tutor" to access a screen where you can switch between different spells and practice casting them. Then say "Adventure" to switch to a turn-based combat game, or "Tutorial" to return to the written instructions.
  • To cast spells, say the name of the spell while making the gesture with one hand over the Leap Motion Controller.
    • Make sure you're speaking and performing the gesture when the turn timer starts and before it hits 0 seconds.
    • Switching between screens using speech commands should also be done before the timer hits 0
    • Keep your hand open and palm facing down over the Leap Motion Controller for the best results

Troubleshooting

When I start app.py, nothing is printed out in the terminal!

The app is unable to connect to the Leap Motion Controller. Make sure it is connected and check the settings in the Leap Motion Control Panel (e.g. enable "Allow Background Apps"). "Gesture recorder connected!" will be printed out when the connection is detected.

When I start app.py, I encounter a Leap import error.

There is no official Leap Motion SDK for Python 3, though there are instructions to build a Python wrapper. I built one for 32-bit Python 3.8.0, which is what we used to develop this system. If it doesn't work for you running the same version of Python on Windows 10, try building a wrapper yourself (instructions can be Google'd) or use one made by someone else (e.g. for Python 3.8 x64, try this: https://github.com/ano0002/Leap-Motion-Python-3.8).

I don't see a timer in the game, or the timer is stuck at the same number.

The game isn't communicating properly with the server. Make sure the server is running at http://127.0.0.1:5000/. Try closing the game and the Flask app, then run the Flask app, make sure "Recorder ready" is printed in the terminal, and then start the game executable again.

The game won't detect that I casted a spell.

Make sure that you are saying the name of the spell while performing the gesture, and completing both the phrase and gesture before the on-screen timer hits 0. Players often perform the gesture too quickly - follow the timing of the gesture in the spell tutor. Make sure you keep your hand open and palm face-down to make sure the Leap Motion Controller can detect your hand. If the spell log still doesn't display a spell, alt-tab to the Python terminal where app.py is running and make sure what you are saying is clearly detected.

My spells are being detected with very low accuracy.

Make sure your gestures are performed before the timer hits 0, and that your hand is open and your palm faces downwards. Keep your hand in the space above the Leap Motion Controller and make gestures aligned vertically and horizontally along the length of the Leap Motion Controller.

Contents

There are many files in this repository that are necessary, for example to load the Unity project, or are included as utility scripts for testing/evaluation, but aren't relevant to running the system. To be concise, the following list will only cover important and/or relevant files and directories for understanding the codebase and running the application.

  • game/ - source code of Unity game and interface
    • Assets/
      • Art/ - title and background images used in the game
      • Audio/bgm.mp3 - background music file
      • JsonDotNet/ - third party Unity library for handling JSON
      • Prefabs/ - Unity object templates
      • Resources/ - creature image assets
      • Scenes/ - Unity scene files for different screens of game
      • Scripts/
        • Adventure/
          • Character/
            • Character.cs - abstract class definition for character description
            • CharacterState.cs - class that contains state of each character (e.g. health)
            • Enemies.cs - implementation of enemy Character classes
            • Player.cs - implementation of player Character class
          • UI/
            • AdventureUIController.cs - main UI control functions
            • ColorFlareScript.cs - color effect when a spell is cast
            • HealthBar.cs - player/enemy health bars
            • NotifierScript.cs - text that pops up describing what happens
          • AdventureController.cs - main controller script for Adventure scene gameplay
        • Misc/
          • BGMScript.cs - plays background music
          • QuitScript.cs - allows player to quit game by pressing esc twice
          • TitleMenuScript.cs - transitions from title to instructions after x seconds
          • TutorialController.cs - main controller script for Tutorial screen
        • Server/
          • ServerManager.cs - functions to make HTTP requests to Python backend server
          • ServerUtils.cs - utility definitions for server requests
        • Tutor/ - scripts for Spell Tutor scene
          • SpellExamples.cs - templates for showing spell gestures
          • SpellNameButtonScript.cs - buttons that can be clicked to switch spells
          • TutorAnimator.cs - animated gesture dot
          • TutorController.cs - main controller script for Spell Tutor scene
          • TutorUIController.cs - functions managing UI of spell tutor
        • GlobalData.cs - static data persisting between scenes
        • Utils.cs - misc utility classes/enums used throughout
    • Builds/win/Kalpana.exe - _built executable for game program`
    • Packages/ - descriptors of packages used in Unity project
    • ProjectSettings/ - general settings for Unity project
  • recognizer/ - source code of Python spell recognition backend
    • gesture/
      • gesture_recognizer.py - gesture recognition functions
      • gesture_test.py - scripts for testing gesture scripts
      • gesture_types.py - class definitions for Gesture and GestureDatabase
      • gesture_util.py - normalizing gesture script
      • hardcoded_gestures.py - initializes GestureDatabase with spell gestures
      • template_matching.py - template matching algorithm based on MP1
    • recorders/
      • leap/ - Leap SDK set up for Python 3.8
      • gesture_recorder.py - class that initializes Leap Motion Controller and processes input from it
      • manual_leap_tester.py - tests Leap input, used to record spell gestures for database
    • shell/ - scripts for testing system using terminal interface
    • speech/
      • speech_recorder.py - functions for speech input and processing
      • speech_test.py - test script for speech recorder
    • trigger/
      • init_trigger_database.py - initializes TriggerDatabase with spell data
      • trigger_database.py - defines TriggerDatabase class
      • trigger_recognizer.py - class that manages spell recognition loop and integrates gesture/speech recognition
    • unity_import_utils/tutor_example_transfer.py - loads data and converts into C# to be copied to Unity
    • app.py - main Flask app and API endpoints
    • config.py - global config variables
    • gesture_data.pkl - pickled database of gesture templates
    • terminal.py - test scripts through terminal
    • trigger_data.pkl - pickled database of spells
  • requirements.txt - Python requirements