Guess the Correlation Game powered by empirica
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.meteor
client
public
readme_screenshots
server
.DS_Store
.gitignore
Readme.md
basic-factors.yaml
example-config.yaml
local.json
package-lock.json
package.json
pilog-config.yaml
pilot2-config.yaml
pilot2-final.yaml
real-experiment.yaml

Readme.md

Guess the Correlation Game

This project was generated with create-empirica-app.

Experiment Demo:

You and a group of friends can play with this experiment as we ran it by following these instructions (assuming you have Meteor installed):

  1. Download the repository (and unzip). Alternatively, from terminal just run:
git clone https://github.com/amaatouq/guess-the-correlation.git
  1. Go into the folder with cd guess-the-correlation
  2. Install the required dependencies by running meteor npm install
  3. Edit the admin password in the settings file local.json to something you like.
  4. Run the local instance with meteor --settings local.json
  5. Go to http://localhost:3000/admin (or whatever port you are running Meteor on).
  6. login with the credentials username: admin and the password you have in local.json
  7. Start a new batch with whatever configuration you want (see the example configuration).

Example Config:

First, you have to enter the Configuration mode instead of the Monitoring model in the admin UI.

config-mode

This will allow you to configure the experiment: Factors, Lobby, and Treatments:

config-mode-inside

Now, you have the option to create your own configuration (see below) or load an example configuration by clicking on import and then choosing the file ./example-config.yaml. Loading the example configurations will choose some example values for the factors (i.e., independent variables), lobby configuration, and few treatments.

The example factors will look like this: factors

And the example treatments will look like this: treatments

Finally, you can go back to the Monitoring mode:

monitoring-mode

Now the Batchs tab make sure you add a new batch, add the treatments you want, choose your lobby configurations, and then start the batch.

batches

Go to http://localhost:3000/ and enjoy! If you don't have 3 friends to play with you, you always can use the new player button in development (for more details see this), which can add an arbitrary number players to the experiment while staying in the same browser (i.e., no need to open different browsers).

game

Changing the experiment to make it your own

The experiment is built with Empirica, which is based on Meteor web development framework. In Empirica, the code is split in 2 main categories: code running on the client (the browser) and code running on the server. This functional separation is immediately reflected in the folders structure.

Client

All code in the /client directory will be ran on the client. The entry point for your app on the client can be found in /client/main.js. In there you will find more details about how to customize how a game Round should be rendered, what Consent message and which Intro Steps you want to present the players with, etc.

The HTML root of you app in /client/main.html shouldn't generally be changed much, other than to update the app's HTML <head>, which contains the app's title, and possibly 3rd party JS and CSS imports.

All styling starts in /client/main.less, and is written in LESS, a simple superset of CSS. You can also add a plain CSS files in /client.

The /client/game, /client/intro, /client/exit directories all contain React components, which compose the UI of your app. If you are new to React, we recommend you try out the official React Tutorial.

Server

Server-side code all starts in the /server/main.js file. In that file, we set an important Empirica integration point, the Empirica.gameInit, which allows to configure each game as they are initiated by Empirica.

From there we import 2 other files. First the /server/callback.js file, which contains all the possible callbacks used in the lifecycle of a game. These callbacks, such as onRoundEnd, offer powerful ways to add logic to a game in a central point (the server), which is often preferable to adding all the logic on the client.

Finally, the /server/bots.js file is where you can add bot definitions to your app.

Public

The /public is here to host any static assets you might need in the game, such as images. For example, if you add an image at /public/my-logo.jpeg, it will be available in the app at http://localhost:3000/my-logo.jpeg.

Settings

We generated a basic settings file (/local.json), which should originally only contain configuration for admin login. More documentation for settings is coming soon.

You can run the app with the settings like this:

meteor --settings local.json

Updating Empirica Core

As new versions of Empirica become available, you might want to update the version you are using in your app. To do so, simply run:

meteor update empirica:core

Learn more