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

Commit

Permalink
Merge pull request #32 from Smashmint/master
Browse files Browse the repository at this point in the history
update README.md for upcoming API changes
  • Loading branch information
Elmer Bulthuis authored Oct 7, 2019
2 parents e53a3b1 + 5df84dd commit 234840d
Showing 1 changed file with 1 addition and 22 deletions.
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ You may also git checkout or [download all the files](https://github.com/Gameye/

## Getting started ##

To play around with the API, we recommend a REST client called Postman. Simply tap the button below to import a pre-made collection of examples.

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/5b09c19acdd27530e455)

1. Use the Gameye SDK to create a match with your desired game-specific options. It's important to specify an unique ID in order to be able to retrieve the details when the match has been created.

2. After the match has ended we will fire a GET request to your webhook to let you know the match is done.
Expand All @@ -53,7 +49,7 @@ Create a match.
```php
$gameye->commandStartMatch([
'matchKey' => 'yourmatchid',
'locationKeys' => ['rotterdam', 'ireland'],
'locationKeys' => ['amsterdam'],
'gameKey' => 'csgo',
'templateKey' => 'esl1on1',
'config' => [
Expand Down Expand Up @@ -85,16 +81,6 @@ Remove the map parameter from the config array and add the following two paramet
```
You can find the id of a custom map at the end of a [Steam Workshop URL](https://steamcommunity.com/workshop/browse/?appid=730).

Get a list of all available games and locations we support.
```php
$gameye->queryGame();
```

Get a list of all available templates (configuration files) for a game.
```php
$gameye->queryTemplate($gameKey);
```

Get a detailed list of all your active matches.
```php
$gameye->queryMatch();
Expand Down Expand Up @@ -182,13 +168,6 @@ You can create a Steam Web API key on the [Steam website](https://steamcommunity

The APP id that you should include for CS:GO is 730


## Examples ##

We have created an example implementation of this SDK based on the Laravel framework which implements all functions provided here, this should show you how to create a basic backend and how to create and manage matches via our API.

+ [Example implementation in Laravel](https://github.com/Gameye/gameye-sdk-example-laravel).

## Contributing ##
We encourage everyone to help us improve our public packages. If you want to contribute please submit a [pull request](https://github.com/Gameye/gameye-sdk-php/pulls).

Expand Down

0 comments on commit 234840d

Please sign in to comment.