This project was generated with create-empirica-app.
You and a group of friends can play with this experiment as we ran it by following these instructions (assuming you have Meteor installed):
- Download the repository (and unzip). Alternatively, from terminal just run:
git clone https://github.com/amaatouq/guess-the-correlation.git
- Go into the folder with
cd guess-the-correlation - Install the required dependencies by running
meteor npm install - Edit the
adminpassword in the settings filelocal.jsonto something you like. - Run the local instance with
meteor --settings local.json - Go to
http://localhost:3000/admin(or whatever port you are running Meteor on). - login with the credentials username:
adminand the password you have inlocal.json - Start a new batch with whatever configuration you want (see the example configuration).
First, you have to enter the Configuration mode instead of the Monitoring model in the admin UI.
This will allow you to configure the experiment: Factors, Lobby, and Treatments:
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:
And the example treatments will look like this:
Finally, you can go back to the 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.
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).
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.
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-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.
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.
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.jsonAs 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- Empirica Website: https://empirica.ly/
- Meteor Tutorial: https://www.meteor.com/tutorials/react/creating-an-app
- React Tutorial: https://reactjs.org/tutorial/tutorial.html
- LESS Intro: http://lesscss.org/#overview
- JavaScript Tutorial: https://javascript.info/