saul / gamevis Goto Github PK

Open-source tool for visualising gameplay data

License: MIT License

JavaScript 25.70% HTML 0.23% CSS 1.16% Go 13.87% Vue 58.33% GLSL 0.71%

gamevis's Introduction

Gamevis

Gamevis is an open-source Electron application for visualising gameplay data developed by Saul Rennison as part of his degree dissertation.

Gamevis is unopinionated and easily fits many genres of games, and includes importers for Counter-Strike: Global Offensive and Dota 2.

Screenshot

Screenshot demonstrating two layered heatmap visualisations:

Installation

1. Prerequisites

Node & npm are already expected to be installed:

brew install libpqxx
npm install -g gulp # required for building
npm install # install app dependencies
gulp # compile JavaScript and stylesheets

2. Database

A Postgres server is by default expected to be running on localhost. The config.json file can be updated at the root of the project to specify a non-default database IP/port.

By default the server is expected to have a database named gamevis with a username and password of gamevis.

Note that no tables need to be generated - the application will automatically generate.

3. Run the app

The application can be started with npm start. However, no sessions are available by default. The importers (see below) can be used to import game sessions into the database.

Visualisations

Multiple visualisations can be show on a single visualisation (as shown in the screenshot):

Heatmaps
Timeline events (e.g., round start)
Discontinuous points (e.g., death location)
Continuous points (e.g., player movement)

Importers

Game	Path	Comments
Counter-Strike: Global Offensive	`importers/csgo`	Run `import.js` with the path to the demo file as the argument.
Dota 2: Reborn	`importers/dota_reborn`	Run `import.go` with the path to the `.dem` replay file as the argument.

Release log

Gamevis is still a work-in-progress and is not expected to be in a production-ready state until Summer 2016. However, changes are committed frequently and any issues should be raised as bugs. Of course pull requests are welcome!

Database

Gamevis expects to connect to a Postgres database of version 9.3 or later due to JSONB querying features. This section details the structure of the database tables, that are automatically generated by the game client.

The full schema is detailed in high-level_architecture.md.

Documentation

Read high-level_architecture.md

License

This project is licensed under the MIT license, see LICENSE.md for the full legalese.

Acknowledgements

Logo derived from Pao Media's gamepad logo, licensed under Creative Commons (Attribution 3.0 Unported).

gamevis's People

Contributors

Stargazers

Watchers

Forkers

gitter-badger iamdey bambusrocken esport-platform-awaresome acmagic mbr001 cfpperche xpz2k15

gamevis's Issues

Add movement event to Dota importer

Add ability to plot other relevant entities for an event

Some entities (such as hegrenade_detonate) have multiple entities associated with them (thrower and grenade). It should be possible to select which entity you wish to plot.

CSGO importer should use transactions

Transactions should be used so errors occurring during import don't leave the database in an inconsistent state.

Add tickrate column to Session table

This will allow us to not assume the tickrate (which I believe is different between CS:GO and Dota 2)

Add ability to export visualisations as images

Import a sample Dota dataset into the database

Add keyboard shortcuts to navigate tabs

Ctrl-1 through 9 should jump to absolute tab
Ctrl-Shift-[ and Ctrl-Shift-] should shift relative tab

Add ability to reorder event layers to arrange render order

Add timeline visualisation

A timeline visualisation should be added with the following features:

Support multiple sessions within a single visualisation
Slider representing time within the game, allowing the user to 'scrub' through game time
Events should be able to be visualised on the slider (e.g., round_start). The events to be shown on the slider should be user selectable.
Spatial events should be able to be plotted on the overview (as connected lines)
Spatial events should be able to be plotted on the overview (as disparate points)

Merge heatmap visualisation into timeline visualisation

Integration may be difficult due to the WebGL heatmap library requiring a WebGL context (whereas the timeline visualisations use a 2d context).

Blocked by #13

Fix `build:js` task always watching

Currently the build:js Gulp task always watches, regardless of whether it was called from the watch task.

Fix performance bottlenecks

There is a significant performance issue when performing SQL queries with a large number of results.

Although the query itself takes only 500ms, it takes JS 5 seconds.

I believe there are also additional performance issues with adding many thousands of elements to an array of objects. Vue.js is trying to observe them all when it's not necessary.

Common entity properties used for filtering, perhaps with user-friendly strings