protos/pogo0.437.0

API

The schema, the .proto files, compiled descriptors and the RPC method table over HTTP, for scripts and other tools: what each route returns and a command to try it.

Basics

Everything the site shows is also served over plain HTTP: the schema as JSON, the generated .proto files, compiled descriptors and the RPC method table. Reading needs no key and no sign-in.

Routes that depend on the game version take ?v=<version> (or ?version=); without it they answer for the latest one. A version the site does not have falls back to the latest, except on /data/schema.json, which answers 404.

Responses carry an ETag. Send it back in If-None-Match and an unchanged file costs a 304 with no body, which makes polling cheap.

Base URL https://protos.chung.pt

More routes with the API key

The routes that manage the site are only listed for whoever holds its API key. Enter it to see them and to run them from this page. It stays in this tab and is forgotten when the tab closes.

Schema

The whole reconstruction in one JSON file: every message with its fields and numbers, every enum with its values, and the RPC methods. It is what the explorer’s search and the decoder load in the browser.

GET/data/schema.json

About 1.8 MB of JSON, served as brotli or gzip when the client accepts them (about 210 KB). With an explicit v the response can be cached for a day.

Query parameters
v
Game version. Unknown versions answer 404.
curl --compressed "https://protos.chung.pt/data/schema.json?v=0.437.0" -o schema.json
GET

GET/api/diff

What changed between two versions: structured JSON summary by default, or a unified .proto diff (format=proto or format=golbat). Defaults to comparing to (latest) against the version before it.

Query parameters
from
Base version. Defaults to the version before to.
to
Target version. Defaults to the latest.
format
json (default), proto (unified diff of vbase.proto), or golbat (unified diff in Golbat style).
curl "https://protos.chung.pt/api/diff?to=0.437.0&format=proto"
GET

.proto files

The .proto sources generated from the schema, one file at a time, as a single file, or zipped.

GET/protos/<file>.proto

One of the generated files of the latest version, for example adventuresync_android.proto. The names are the ones in the zip.

curl -O "https://protos.chung.pt/protos/adventuresync_android.proto"
GET

GET/protos/vbase.proto

Every message and enum in one file, for tools that want a single schema.

curl -O "https://protos.chung.pt/protos/vbase.proto"
GET

GET/protos/pogo-protos-<version>.zip

All the files of the latest version, vbase.proto included.

curl -O "https://protos.chung.pt/protos/pogo-protos-0.437.0.zip"
GET

GET/protos/v/<version>/<file>

The same files for a given version (cached for 60 seconds).

curl -O "https://protos.chung.pt/protos/v/0.437.0/vbase.proto"
GET

Descriptors and RPC methods

Compiled forms of the schema, made for Traffic Light but useful to anything that decodes traffic: a binary descriptor, the Python module and the table of RPC methods.

GET/trafficlight/info

What is available for a version: counts, the URL of each file, its size and SHA-256, and the settings Traffic Light needs.

Query parameters
v
Game version.
curl "https://protos.chung.pt/trafficlight/info"
GET

GET/trafficlight/pogo.desc

A binary FileDescriptorSet, as written by protoc --descriptor_set_out. Load it to decode messages without compiling anything.

Query parameters
v
Game version.
curl -O "https://protos.chung.pt/trafficlight/pogo.desc"
GET

GET/trafficlight/methods.json

Each RPC method’s id, name, request_message and response_message, wrapped with version, updated_at and total_methods.

Query parameters
v
Game version.
format=raw
Just the array of methods, without the wrapper.
curl "https://protos.chung.pt/trafficlight/methods.json?format=raw"
GET

GET/trafficlight/pogo_pb2.py

The Python module generated by protoc --python_out.

Query parameters
v
Game version.
curl -O "https://protos.chung.pt/trafficlight/pogo_pb2.py"
GET

GET/trafficlight/v/<version>/<file>

The same files with the version in the path, for configuration that cannot carry a query string. <file> is pogo.desc, methods.json, pogo_pb2.py or vbase.proto.

curl -O "https://protos.chung.pt/trafficlight/v/0.437.0/pogo.desc"
GET

GET/trafficlight

A page listing the above for people. Clients that ask for JSON (Accept: application/json, or ?json) get the same answer as /trafficlight/info.

curl "https://protos.chung.pt/trafficlight?json"
GET

Golbat

Single-file vbase.proto formatted for Golbat (option go_package = "golbat.com/pogo";, deduplicated Internal*/Titan* types, and Golbat enum value naming for protoc --go_out).

GET/golbat/vbase.proto

Golbat-compatible vbase.proto for the latest version, ready for updateproto.sh or protoc --go_out.

curl -O "https://protos.chung.pt/golbat/vbase.proto"
GET

GET/golbat/v/<version>/vbase.proto

The same Golbat-compatible vbase.proto for a given version. Returns 404 if the version is not installed.

curl -O "https://protos.chung.pt/golbat/v/0.437.0/vbase.proto"
GET

GET/golbat/diff

Unified .proto diff between two versions in Golbat’s vbase.proto format (option go_package, enum naming). Defaults to comparing to (latest) against the version before it.

Query parameters
from
Base version. Defaults to the version before to.
to
Target version. Defaults to the latest.
curl "https://protos.chung.pt/golbat/diff?to=0.437.0"
GET

Code generation

Go source and JSON generated from the RPC method table, ready to be written into the projects that use them.

GET/api/codegen

The index: the version being served, how many methods it has, the versions available and the URL of each target.

Query parameters
v
Game version.
curl "https://protos.chung.pt/api/codegen"
GET

GET/api/codegen/controller-methods.go

Method constants, String() and lookup maps, for controller/pogo/methods.go. Also answers at /api/codegen/methods.go.

Query parameters
v
Game version.
download=1
Send it as an attachment.
curl -s "https://protos.chung.pt/api/codegen/controller-methods.go" > controller/pogo/methods.go
GET

GET/api/codegen/methods.json

The method table with version, updated_at and total_methods.

Query parameters
v
Game version.
curl "https://protos.chung.pt/api/codegen/methods.json"
GET

HTML reference

A single HTML page documenting every message and enum, generated from the .proto files.

GET/docs/pogoprotos-doc.html

The generated page. /docs redirects here.

curl -O "https://protos.chung.pt/docs/pogoprotos-doc.html"
GET

GET/api/doc

Whether the page exists for a version, and where to read it.

Query parameters
version
Game version.
curl "https://protos.chung.pt/api/doc"
GET