/POGOProtos

A central repository for all proto files of PokémonGO.

Primary LanguagePythonMIT LicenseMIT

Note: This repository will not be consistently updated. Only quest data, moveset data, and Pokemon will be updated manually.

POGOProtos Build Status Maintainability Test Coverage Donate

alt text The contents of this repo are a proof of concept and are for educational use onlyalt text

This repository contains the ProtoBuf .proto files needed to decode the PokémonGo RPC.

Implemented messages types

Versioning

We are following semantic versioning for POGOProtos. Every version will be mapped to their current PokémonGo version.

Version API Notes Extra
2.44.0 0.145.0 Compatible Protocol Buffers v3.8.0

Usage

If you want to figure out the current version in an automated system, use this file.

.current-version

Note: This file will contain pre-release versions too.

Preparation

Current recommended protoc version: "Protocol Buffers v3.8.0".

You can find download links here.

Windows

Be sure to add protoc to your environmental path.

*nix

Ensure that you have the newest version of protoc installed.

OS X

Use homebrew to install protobuf with brew install --devel protobuf.

Compilation

NOTE: compile_single.py is outed!

The compilation creates output specifically for the target language, i.e. respecting naming conventions, etc.
This is an example of how the generated code will be organized:

python compile.py php:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.php
python compile.py cpp:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.pb.cpp
python compile.py csharp:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.g.cs
python compile.py objc:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.pbobjc.m
python compile.py python:
 - POGOProtos/Data/*.proto -> pogoprotos/data/__init__.py
 - POGOProtos/Data/PlayerData.proto -> pogoprotos/data/player_data_pb2.py
python compile.py ruby:
 - POGOProtos/Data/*.proto -> pogoprotos/data.rb
 - POGOProtos/Data/PlayerData.proto -> pogoprotos/data/player_data.rb

alt text //TODO: help repo// alt text

python compile.py go:
- POGOProtos/Data/*.proto -> github.com/aeonlucid/pogoprotos/data
- POGOProtos/Data/PlayerData.proto -> github.com/aeonlucid/pogoprotos/data/player_data.pb.go
python compile.py java:
 - POGOProtos/Data/*.proto -> com/github/aeonlucid/pogoprotos/Data.java
python compile.py js:
- POGOProtos/**/*.proto -> pogoprotos.js
python compile.py rust:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.rs
python compile.py swift:
 - POGOProtos/Data/PlayerData.proto -> POGOProtos/Data/PlayerData.pb.swift

Extra information

Libraries

If you don't want to compile POGOProtos but instead use it directly, check out the following repository.

Language Source Status
NodeJS https://github.com/pogosandbox/pogobuf OK
NodeJS (pure JS) https://github.com/pogosandbox/pogo-protos npm version
.NET (nuget pack) https://github.com/Furtif/POGOProtos.Core NuGet
Swift https://github.com/123FLO321/POGOProtos-Swift OK
Python https://github.com/PotatoMapper/POGOProtosPython OK
Java https://github.com/pokemongo-dev-contrib/pogoprotos-java OK
Additional resources Source Status
Gamemaster Json https://github.com/pokemongo-dev-contrib/pokemongo-game-master OK

CREDITS