📖
Empirica v1 Docs
  • Introduction
  • Getting Started
    • Setup
      • Windows WSL Instructions
    • Creating your experiment
    • Running your experiment
    • Updating your experiment
  • Guides
    • Tutorial: Your First Experiment
      • Part 1: Getting Started
      • Part 2: Configuring the Experiment
      • Part 3: Adding Social Information and New Factors
      • Part 4: Adding Chats
      • Part 5: Adding Bots
    • The Settings File
      • Specifying Login Details
      • Setting player ids via URL queries
      • Connecting Locally to MongoDB
    • The Admin Panel
    • Special Empirica Elements (and how to modify them)
    • Deploying Your Experiment
      • Database
      • Hosting
    • Managing the Data
    • Using Custom Collections
  • Conceptual Overview
    • Structure
    • Game Life Cycle
      • Customising when players submit stages
    • Concepts
    • Randomization & Batches
    • API
  • FAQ
    • I need help!
    • The Processes and Elements of an Empirica Experiment
    • Managing Players and Games
  • Community Demos
    • Guess The Correlation
    • Random Dot Motion
    • Room Assignment
  • Tips & Tricks
    • Helpful Linux Commands
    • Code Editors
  • Links
    • Empirica website
    • Twitter
    • GitHub
Powered by GitBook
On this page
  • Beginning and intro steps
  • gameInit
  • Rounds and Stages
  • Game end and exit steps
  • List of callbacks

Was this helpful?

  1. Conceptual Overview

Game Life Cycle

PreviousStructureNextCustomising when players submit stages

Last updated 3 years ago

Was this helpful?

Elements on this page refer to the f, , and of an Empirica experiment.

Empirica experiments are event driven. The image below summarizes the lifecycle from the beginning of a game through exit steps.

Beginning and intro steps

In the admin panel, you would create a Batch of games for players to join. Players enter the game where they go through a consent form (optional), they provide an identifier (which can be set via URL queries), and they do the intro steps (the instructions and other components you have set in the intro steps. All of these are set by you in the ./client . During these steps, players are asynchronous; namely, they complete these steps at their own pace until they have finished them, independent from the pace of other players.

gameInit

Once players finish the intro steps they are sent to a lobby where they wait until every player has joined. When every player has joined, the Game object is created based on what is set in ./server/main.js in the Empirica.gameInit() . This is where certain parameters are set, and where the Rounds and their Stages are created.

In the ./server/callbacks.js, Empirica.onGameStart() is also triggered at the same time as Empirica.gameInit(). Any pre-game preparations can be done in either gameInit or onGameStart interchangeably. It might make sense to the Game designer to split the overall mandatory Game configuration (Rounds and Stages) in gameInit, from data initialization (using set on Game, Players, Rounds and Stages objects) in onGameStart, but it is not required.

Rounds and Stages

Then players go through each Stage of each Round. Once a Stage is finished, they move on to the next. If this was the last Stage of a Round, they move on to the next Round. If this was the last Round, they move on to the Exit Steps.

During these steps, players are synchronous; namely, every player has to finish each stage before they can all move on to the next.

In the ./server/callbacks.js, a series of callbacks are triggered during this process:

See our guide on customising when player submit a stage:

Game end and exit steps

After which, the players goes through the exit steps. During these steps, players are asynchronous; namely, they complete these steps at their own pace until they have finished them, independent from the pace of other players.

List of callbacks

The list of callbacks goes as follows in order:

  • gameInit Required

  • onGameStart

  • onRoundStart Repeated for each Round

  • onStageStart Repeated for each Stage

  • onStageEnd Repeated for each Stage

  • onRoundEnd Repeated for each Round

  • onGameEnd

Before a round starts, is called.

Before a stages starts, is called.

When a Stage ends, is called.

When a Round ends, is called.

Finally, when the last Round ends, after the end of Stage and Round callbacks are triggered, the callback is called in the ./server/callbacks.js.

onRoundStart
onStageStart
onStageEnd
onRoundEnd
Customising when players submit stages
onGameEnd
ile structure
concepts
API