pubg-rb

Wraps the PUBG REST API for convenient access from ruby applications.

Documentation for the PUBG REST API can be found here: https://documentation.playbattlegrounds.com/en/introduction.html

If you need help please jump into the Discord server https://discord.gg/GZpFFN

Notice this wrapper is still in development. Im sure some things are broken when dealing with PC match data. Ive been testing using an xbox account.

To install using Bundler grab the latest stable version:

gem 'pubg-rb'

And then execute:

bundle install

To manually install pubg-rb via Rubygems simply gem install:

gem install pubg-rb

To build and install the development branch yourself from latest source:

git@github.com:pubstatsg/pubg-rb.git
cd pubg-rb
make install

require "pubg-rb"

# put your own credentials here
api_key = "xxxxxxxxxxxxxxxxxxxxxxxxx"
platform_region = "xbox-na"

@pubg = PUBG::Client.new(api_key, platform_region)

an example for getting the status

@pubg.status

Set up a client to talk to the PUBG API.

@pubg = PUBG::Client.new("api_key", "platform_region")

• note if platform_region is set on the client or environment variablePUBG_PLATFORM_REGION it does not need to be set elsewhere

Get a collection of players by name's.

players = @pubg.players("Optional_platform_region", "acidtib,ImAverageSniper")

players.original
players.data
players.links
players.meta

Get a collection of players by player_id's.

players = @pubg.players("Optional_platform_region", "account.c975e15685614c5f9da44f25598f7670,account.c6d7393a0fed4613973e3d89582f23fc")

players.original
players.data
players.links
players.meta

Get a single player by the player_id.

player = @pubg.player("Optional_platform_region", "account.c975e15685614c5f9da44f25598f7670")

player.original
player.data
player.links
player.meta
player.player
player.playerId
player.matches
player.season("division.bro.official.xb-pre1")

Get season information for a single player.

season = player.season("xbox-na", "division.bro.official.xb-pre1")

season.original
season.data
season.links
season.meta

match = @pubg.match("895e77a8-0efa-492b-b256-3e9bf79097e6")

match.original
match.data
match.included
match.links
match.meta
match.telemetry
match.participants
match.roster

Check the status of the API.

status = @pubg.status

status.original
status.data

Get a list of available seasons.

seasons = @pubg.seasons("Optional_platform_region")

seasons.original
seasons.data
seasons.links
seasons.meta

Telemetry provides further insight into a match.

telemetry = @pubg.telemetry("https://telemetry-cdn...c30c-telemetry.json")

telemetry.original
telemetry.playerLogin
telemetry.playerCreate
telemetry.playerPosition
telemetry.playerAttack
telemetry.itemPickup
telemetry.itemEquip
telemetry.itemUnequip
telemetry.vehicleRide

After checking out the repo, run make setup to install dependencies. Then, run make test to run the tests. You can also run make console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run make install. To release a new version, update the version number in version.rb, and then run make release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/pubstatsg/pubg-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Pubg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.