1.2. Welcome to OpenGameData

Welcome

Welcome to the OpenGameData Project! This website will, at some point, describe all aspects of the OpenGameData tools for collecting, processing, analyzing, and distributing event-based data from educational games and game-like interactive digital media.

Documentation Organization

The OpenGameData documentation is broken down into 3 guides, plus the library API reference docs. Each guide has one more more units, each made up of several chapters. Together, the guides describe all parts of the OpenGameData infrastructure.

The guides and units are as follows:

  • Introduction & Organization: An overview of the OpenGameData project and documentation.

    1. Getting Started: Identify your use case, and which part of the documentation you should read.

  • User Guide: User-level documentation. Intended for researchers and analysts who want to use datasets and/or tooling from OpenGameData, without any additional programming work.

    1. OpenGameData Core Basics: The basics of using OpenGameData Core, including configuration and basic data exports.

    2. Data Types and Logging: A discussion of the OpenGameData Event Schema, and the several software packages used to collect event data.

    3. OpenGameData Web APIs: Documentation of the OpenGameData Web APIs for data storage and access.

    4. Data Replay Tools: An introduction to OpenGameData-based tools for data replay.

    5. Data Analysis & Visualization Tools: An introduction to OpenGameData-based tools for data analysis, including Jupyter Notebook templates and data dashboards.

  • Game Producer Guide: Documentation for game producers who want to use OpenGameData as a telemetry logging and analytics solution. This includes information on how to prepare for logging with your game, and ways for your team to use the collected data.

    1. Event Logging: How to identify the events that occur in your game, which can be logged with OpenGameData telemetry tools.

  • Game/Data Engineering Guide: Documentation for engineers who want to use OpenGameData libraries in their projects and products. This includes logging integration in games, and feature extraction modules for game data.

    1. Event Logging: How to use the OpenGameData logging libraries to log telemetry from Unity or JavaScript projects.

    2. Detectors & Feature Engineering: How to write data Generators in OpenGameData Core to create refined analytics from raw event data.

  • OGD Developer Guide: Documentation for developers who want to work on the core OpenGameData libraries and software tools.

    1. Core Architecture: A comprehensive review of the data processing architecture in OpenGameData Core, including how to integrate Core components into your own 3rd-party tool(s).

    2. OGD ``Common’’ Library: A comprehensive review of the library containing base classes and other utilities used across multiple parts of the OGD software ecosystem.

    3. OpenGameData Web APIs: Documentation of the OpenGameData Web APIs for data storage and access.

    4. Meta-Documentation: Documentation for contributors working on core OGD infrastructure and documentation, covering topics such as coding conventions and our software reference platform.

  • Core API Reference: API reference for the OpenGameData Core Python package.

Problems with this Website?

If you encounter any issues with this documentation site, such as missing images or broken links, please feel free to report the issue on our documentation GitHub page: Submit an Issue Report

OpenGameData Pipeline

STUB: This section is on the to-do list.

OpenGameData Tools & Packages

STUB: This section is on the to-do list.