The Frame Game is an in-progress crowdsourcing game that seeks to provide users with prompts for creative writing while encouraging them to create semantic role labelling annotations of their sentences.
| Filename | Type | Scene | Description |
| MenuScript.cs | C# Script | MainMenu | Initiates the game, facilitates login with Facebook SDK |
| HomeScreenController.cs | C# Script | StartScreen (see green on flowchart) | First screen of the game, includes terms & conditions, information about FrameNet, and gameplay instructions |
| GameScript.cs | C# Script | SRLGame (see blue on flowchart) | Actual gameplay of the game, gathers frames from the backend, allows users to annotate their own work |
| ExampleController.cs | C# Script | ViewerMode | Allows users to see others' annotated sentences |
| TextMeshPro/Examples & Extras/Scripts/CustomTextSelector.cs | C# Script | n/a | Faciliates the interaction between the text elements and the user for text selecting, referenced by GameScript.cs and ExampleController.cs to create and display annotations. |
| StoredInfo.cs | C# Script | n/a | Holds all the classes and structures that model FrameNet data that the files draw from |
| Backend/frameGameBackend.py | Python Script | n/a | Sends and receives information from the game, is used to parse and communicate FrameNet data with the game. |
The other assets include fonts, spritesheets, and plugins used by the game.
- Unity (C# for scripting)
- Flask (Python) for the backend
- Download or clone the repository
- Place the Backend/frameGameBackend.py folder in the same folder as the FrameNet data
- Create a new project in [Unity](https://unity.com/learn)
- Replace the contents of the Assets folder with the contents of this repository, fill in the necessary information (i.e. app id for Facebook SDK use)
- Replace the contents of the Assets folder with the contents of this repository
- [Run](https://flask.palletsprojects.com/en/2.1.x/quickstart/) the flask backend at the folder where you placed it in (2)
- Run the game in Unity
Made by Emily Amspoker during the SUPERB REU, 2022.