1.3. Getting Started in OpenGameData
This chapter will help you to get up and running with the `OpenGameData` tools. There are a few use-cases that this documentation will address - please review the following section to determine which case you need, and advance to the corresponding sections.
OpenGameData Use-Cases
I need to…
Retrieve a Dataset from my OpenGameData Data Source
You should read the following portions of the documentation in order to retrieve a dataset:
Start by installing OpenGameData.
When choosing between a “Package” and “Local Source” install, you should choose the “Package” option
autolink for the link above: Installation as Package
If the game whose data you want to retrieve has not previously been added to OpenGameData, you should instead begin with Step 2 of integrating a new game.
Follow the remaining steps as needed, and return to this spot.
Check your OpenGameData configuration
Perform your dataset export
Integrate a new Game with OpenGameData
You should read the following portions of the documentation in order to integrate a new game with OpenGameData.:
Start by adding event logging to your game.
This chapter will walk you through the process of using the logging client and server to capture event data, optionally setting up a new OpenGameData data source.
Next, install OpenGameData.
When choosing between a “Package” and “Local Source” install, you should choose the “Local Source” option
Finally, add a configuration
Integrate a new Data Source with OpenGameData
STUB: This section is on the to-do list.
Perform Feature Engineering on my Raw Event Data
STUB: This section is on the to-do list.
Perform OpenGameData Processing in my 3rd-Party Tool
STUB: This section is on the to-do list.
Special Case: I am a Data Team Intern at Field Day Lab
STUB: This section is on the to-do list.