Skip to content
This repository has been archived by the owner on Oct 28, 2020. It is now read-only.

Gameye/gameye-sdk-node

Repository files navigation

Gameye SDK for Node.js

Create eSport and competitive matches for Counter-Strike: Global Offensive, Team Fortress 2, Left 4 Dead 2, Killing Floor 2, Insurgency and Day of Infamy for your platform without fixed monthly costs or any need for your own server infrastructure. Simply implement the Gameye API to kick off online matches when you need them; you will even be able to implement the scores/statistics directly on your website. How cool is that!

Node version

You need node.js v10 or higher to use this library.

Installation

You need an API key to use this SDK, to obtain a free Gameye API key, please send us an email

Then, install with

npm install @gameye/sdk

Typescript type declarations are automatically installed.

Example!

Watch bots kill each other and get acquainted with our sdk and real-time statistics.

First, get an API key! Then checkout this repo on your computer. Install all dependencies with

npm install

Then, export your api key as an environment variable, like this

export GAMEYE_API_TOKEN=mysupersecretkey

And now, run

node ./node/examples/bots

to see bots kill each other!

Contributing

We encourage everyone to help us improve our public packages. If you want to contribute please submit a pull request.

But, never commit something that breaks the build! You may prevent this a little bit by linking the test.sh script as a git pre-commit hook!

like this:

ln test.sh .git/hooks/pre-commit

Now, just before every commit, your code will be compiled and linted!

License

BSD (Berkeley Software Distribution) License. 2017-2018 Gameye B.V.

Support

Contact: gameye.comsupport@gameye.com