GitXplorerGitXplorer
e

FrameGameAssets

public
1 stars
0 forks
12 issues

Commits

List of commits on branch master.
Verified
6e5ff10ad61d9ee0144c08df96df69d4526bf5be

Merge pull request #2 from eamspoker/add-license-1

eeamspoker committed 2 years ago
Verified
514879a8d2be48648aec5e33d90ca7714583d65f

Create LICENSE.md

eeamspoker committed 2 years ago
Verified
6a298bfea77574b8d565b07d80874a09991e7f7a

Update README.md

eeamspoker committed 2 years ago
Verified
330b2dc16a66cef67fd62751ba1cc514575138bc

Update README.md

eeamspoker committed 2 years ago
Verified
f1390a9178de5f976b6cc5ebc32e81407865efb6

Update README.md

eeamspoker committed 2 years ago
Verified
cda93cf83c91b94f799ceba88c43ae14aa04b431

Update README.md

eeamspoker committed 2 years ago

README

The README file for this repository.

The Frame Game

Open Issues

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.

Structure of Game

Blank diagram - Page 1

Scripts

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.

Other Assets

The other assets include fonts, spritesheets, and plugins used by the game.

Tech Stack

  • Unity (C# for scripting)
  • Flask (Python) for the backend

Setting Up

  1. Download or clone the repository
  2. Place the Backend/frameGameBackend.py folder in the same folder as the FrameNet data
  3. Create a new project in [Unity](https://unity.com/learn)
  4. 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)
  5. Replace the contents of the Assets folder with the contents of this repository
  6. [Run](https://flask.palletsprojects.com/en/2.1.x/quickstart/) the flask backend at the folder where you placed it in (2)
  7. Run the game in Unity

License

Made by Emily Amspoker during the SUPERB REU, 2022.