Package Exports

lol-tournament-code

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lol-tournament-code) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

lol-tournament-code

This is an utility module that allows the creation of custom games for tournament purposes. It provides the possibility to receive the in game statistics, after the game has eneded, to a specified URL.

Download

lol-tournament-code is installable via:

GitHub git clone https://github.com/Pupix/lol-tournament-code.git
bower: bower install lol-tournament-code
npm: npm install lol-tournament-code

Quick Examples

opt = {
  name: 'TournamentGame'
}

tournmentCode(opt)
// => "pvpnet://lol/customgame/joinorcreate/map11/pick6/team5/specDROPINONLY/eyJuYW1lIjoiVG91cm5hbW5ldEdhbWUiLCJleHRyYSI6IiJ9"

opt = {
  name: '3v3Tournament',
  password: 'qweasdzxc',
  map: 10,
  type: 6,
  size: 3,
  spectators: 'DROPINONLY',
  reportURL: 'https://example.com/game-reports',
  extra: 'This was an awesome tournmanet'
}

tournmentCode(opt)
// => "pvpnet://lol/customgame/joinorcreate/map10/pick6/team5/specDROPINONLY/eyJuY…YzVG91cm5hbWVudCIsImV4dHJhIjoiVGhpcyB3YXMgYW4gYXdlc29tZSB0b3Vybm1hbmV0In0="

Usage

node

var tournamentCode = require('lol-tournament-code');

tournamentCode({name: 'TournamentGame'});
// => "pvpnet://lol/customgame/joinorcreate/map11/pick6/team5/specDROPINONLY/eyJuYW1lIjoiVG91cm5hbW5ldEdhbWUiLCJleHRyYSI6IiJ9"

browser

You can either import the .js files or import the .html file

HTML Import

<link rel="import" href="bower_components/lol-tournament-code.html">
<script>
  LoL.tournamentCode({name: 'TournamentGame'});
  // => "pvpnet://lol/customgame/joinorcreate/map11/pick6/team5/specDROPINONLY/eyJuYW1lIjoiVG91cm5hbW5ldEdhbWUiLCJleHRyYSI6IiJ9"
</script>

Script

<script src="bower_components/expandjs/dist/expandjs.min.js"></script>
<script src="bower_components/lol-tournament-code/dist/lol-tournament-code.min.js"></script>

<script>
  LoL.tournamentCode({name: 'TournamentGame'});
  // => "pvpnet://lol/customgame/joinorcreate/map11/pick6/team5/specDROPINONLY/eyJuYW1lIjoiVG91cm5hbW5ldEdhbWUiLCJleHRyYSI6IiJ9"
</script>

Documentation

The generator works based on a configuration object with various options passed to it.

opt.name

This is the name of the lobby that will be shows in the custom games list. This is only required option.

opt.password (Default: '')

The password of the lobby, it's recommended to set one so random players don't access your lobby via the Custom Game iterface of the game client.

opt.map (Default: 11)

The map ID where the game will be played, it defaults to the new Summoner's Rift. Possible IDs are the following:

1: Summoner's Rift (Summer)
2: Summoner's Rift (Autumn)
3: Proving Grounds
4: Twisted Treeline
8: Crystal Scar
10: Twisted Treeline (New)
11: Summoner's Rift (New)
12: Howling Abyss

opt.type (Default: 6)

The game type to be palyed, it defaults to Tournament Draft. Possible IDs are the following:

1: Blind Pick
2: Draft Mode
4: All Random
6: Tournament Draft

opt.size (Default: 5)

The maximum number of players allowed for each team in the game to be played. Valid values are from 1 throgh 5.

JSPM