Intentions Game

Getting Started

Client

Before building or previewing the client, ensure that the Node.js version 14+ is installed on your system. Download Node.js here and install Yarn using this command npm i -g yarn.

After installing Yarn, run yarn in the top-level repository directory to install all dependencies. Refer to Development below for other commands to build and preview the client.

Server

Caution

The server component of the Intentions Game has been deprecated, and partner computations are now performed by the client. The documentation below pertains to the archived server.zip file contents.

The server uses Python and R to generate partner behavior for a phase of the task. To run the server, the following packages are required:

Required R packages (including dependencies):

• codetools
• iterators
• jsonlite
• foreach
• doParallel
• cli
• generics
• glue
• lifecycle
• magrittr
• pillar
• R6
• rlang
• tibble
• tidyselect
• utf8
• fansi
• vctrs
• pkgconfig
• withr
• dplyr
• logger

Development

• yarn clean: Remove all client build artefacts and logs.
• yarn build: Create a production build of the client.
• yarn lint: Run the client source code through ESLint to check for any style violations.
• yarn start: Start a Webpack HMR-compatible development server to preview the client locally on localhost:8080.
• yarn test: Run all client tests.

Offline Usage

The task includes a packages directory containing all required R packages. To use these packages, set the useOfflinePackages manipulation within Configuration.ts to true. Each package was built and prepared using the rwasm tool.

Use the yarn build command to build the client with the offline packages, build output is placed in the dist directory. To run the task, use the yarn start command or run an instance of http-server using the dist directory.

Additional Features

• Alternate input scheme for usage with MRI controllers. Keys 1 and 2 used to move UI selection cursor, 3 used to interact with UI element. Experiment collects 5 key input timestamps (in Unix epoch format) and stores at the end of the data file.
• Incrementally saving data to localStorage for each experiment. In the case of the game crashing or exiting the browser window, the next time the game is accessed, an alert will prompt the user that the previous experiment did not complete and allow them to download the data captured. This feature is disabled by default (for online testing scenarios using Gorilla). It is advisable to enable this feature when the faciliator is physically present to deliver the experiment.

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Issues and Feedback

Please contact Henry Burgess <henry.burgess@wustl.edu> for all code-related issues and feedback.