Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajedi32/echovr_api_docs
Unofficial documentation for Echo VR's HTTP API
https://github.com/ajedi32/echovr_api_docs
api-client documentation echo-arena echo-vr virtual-reality
Last synced: about 3 hours ago
JSON representation
Unofficial documentation for Echo VR's HTTP API
- Host: GitHub
- URL: https://github.com/ajedi32/echovr_api_docs
- Owner: Ajedi32
- Created: 2018-11-10T01:03:17.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-04T16:06:15.000Z (about 3 years ago)
- Last Synced: 2024-04-17T21:21:19.024Z (7 months ago)
- Topics: api-client, documentation, echo-arena, echo-vr, virtual-reality
- Size: 131 KB
- Stars: 23
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Echo VR API Documentation
Unofficial documentation for Echo VR's HTTP API.
## Summary
Echo Arena has an HTTP API available for querying current game state. This API
listens locally on port 6721 (`http://127.0.0.1:6721/session`). This API now requires a setting to be toggled on.
Note that if any other service is alredy bound to this (TCP) port, which often
happens on Windows, Echo will not be able to bind to it. To kill any services
using it, run `net stop HTTP` in an administrator command prompt.
This repository aims to document all the functionality of this API.
## API Endpoints
### GET /session
This returns a detailed representation of the current state of the match. The response is a JSON string, which can be parsed with any standard JSON parser.
Example response (formatted for readability):
{
"client_name": "Timemaster111",
"sessionid": "1C32B3DA-F1F6-4B17-8BAE-FD1BC59C28BD",
"sessionip": "184.154.39.222",
"match_type": "Echo_Arena", // "Echo_Arena_Private", "Echo_Arena", "Echo_Combat", "Echo_Combat_Private", "Social_2.0", "INVALID GAMETYPE"
"map_name": "mpl_arena_a", // "mpl_arena_a", "mpl_lobby_b2", mpl_combat_dyson, mpl_combat_combustion, mpl_combat_fission, mpl_combat_gauss, "INVALID LEVEL"
"game_clock": 215.09978,
"game_clock_display": "03:35.09",
"private_match": false,
"total_round_count": 1,
"blue_round_score": 0,
"orange_round_score": 0,
"blue_points": 2,
"orange_points": 4,
"tournament_match": false,
"blue_team_restart_request": 0,
"orange_team_restart_request": 0,
"right_shoulder_pressed": 0.0,
"right_shoulder_pressed2": 0.0,
"left_shoulder_pressed": 0.0,
"left_shoulder_pressed2": 0.0,
"packet_loss_ratio": TBC,
"game_status": "score", // "pre_match", "round_start", "playing", "score", "round_over", "round_start", "post_match", "pre_sudden_death", "sudden_death", "post_sudden_death"
"pause": {
"paused_state": "unpaused", // "unpaused", "unpausing", "paused", "paused_requested"
"unpaused_team": "none", // "orange", "blue", "none"
"paused_requested_team": "none", // "orange", "blue", "none"
"unpaused_timer": 0.0,
"paused_timer": 0.0
},
"possession": [
1,
0
],
"last_throw": {
"arm_speed": 0.0,
"total_speed": 0.0,
"off_axis_spin_deg": 0.0,
"wrist_throw_penalty": 0.0,
"rot_per_sec": 0.0,
"pot_speed_from_rot": 0.0,
"speed_from_arm": 0.0,
"speed_from_movement": 0.0,
"speed_from_wrist": 0.0,
"wrist_align_to_throw_deg": 0.0,
"throw_align_to_movement_deg": 0.0,
"off_axis_penalty": 0.0,
"throw_move_penalty": 0.0
},
"last_score": {
"disc_speed": 0.0,
"team": "orange", // "orange", "blue", "none"
"goal_type": "SLAM DUNK", // "[NO GOAL]", "SLAM DUNK", "INSIDE SHOT", "LONG SHOT", "BOUNCE SHOT", "LONG BOUNCE SHOT", "BUMPER_SHOT" (TBC)
"point_amount": 2,
"distance_thrown": 0.40054435,
"person_scored": "Bob",
"assist_scored": "[INVALID]"
},
"disc": {
"position": [
0.0,
0.0,
0.0
],
"forward": [
0.0,
0.0,
1.0
],
"left": [
1.0,
0.0,
0.0
],
"up": [
0.0,
1.0,
0.0
],
"velocity": [
0.0,
0.0,
0.0
],
"bounce_count": 0
},
"player": {
"vr_left": [
0.78700006,
0.072000004,
0.61300004
],
"vr_position": [
-3.9650002,
2.2310002,
-34.506001
],
"vr_forward": [
-0.61700004,
0.091000006,
0.78200006
],
"vr_up": [
0.0,
0.99300003,
-0.116
]
},
"teams": [
{
"team": "BLUE TEAM",
"possession": false,
"stats": {
"points": 2,
"possession_time": 32.055771,
"interceptions": 0,
"blocks": 0,
"steals": 1,
"catches": 0,
"passes": 0,
"saves": 3,
"goals": 0,
"stuns": 6,
"assists": 1,
"shots_taken": 0
},
"players": [
{
"name": "Timemaster111",
"playerid": 0,
"userid": 3561909181390317,
"number": 5,
"level": 50,
"ping": 48,
"stunned": false,
"invulnerable": false,
"possession": false,
"holding_left": "none",
"holding_right": "none",
"blocking": false,
"stats": {
"possession_time": 8.9302616,
"points": 0,
"saves": 1,
"goals": 0,
"stuns": 3,
"passes": 0,
"catches": 0,
"steals": 0,
"blocks": 0,
"interceptions": 0,
"assists": 0,
"shots_taken": 0
},
"velocity": [
0.48200002,
0.83300006,
-2.3240001
],
"head": {
"position": [
-2.1360002,
2.098,
-33.876003
],
"forward": [
0.14600001,
-0.36400002,
0.92000002
],
"left": [
0.98400003,
-0.045000002,
-0.17400001
],
"up": [
0.105,
0.93000007,
0.35200003
]
},
"body": {
"position": [
-2.1360002,
2.098,
-33.876003
],
"forward": [
0.296,
0.001,
0.95500004
],
"left": [
0.95500004,
-0.0020000001,
-0.296
],
"up": [
0.001,
1.0,
-0.001
]
},
"rhand": {
"pos": [
-2.3390002,
1.8030001,
-33.733002
],
"forward": [
-0.259,
0.74000001,
0.62
],
"left": [
0.80900002,
-0.18400002,
0.55800003
],
"up": [
0.52700001,
0.64700001,
-0.55200005
]
},
"lhand": {
"pos": [
-2.0700002,
1.8610001,
-33.788002
],
"forward": [
-0.44800001,
0.73100001,
0.51500005
],
"left": [
0.89200002,
0.32200003,
0.317
],
"up": [
0.066,
0.60100001,
-0.79600006
]
},
},
{
/* ... more players ... */
}
]
},
{
"team": "ORANGE TEAM",
/* ... same as blue team ... */
},
{
"team": "SPECTATORS",
/* ... same as blue team ... */
}
]
}
#### Properties
The response is a JSON object, with the following properties:
#### `client_name`
The username of the signed-in user.
#### `sessionid`
A 128-bit string-encoded GUID of the session.
#### `sessionip`
IP address to the current server
#### `match_type`
Represents the type of match being played.
Possible values:
* `"Echo_Arena_Private"`
* `"Echo_Arena"`
* `"Echo_Combat"`
* `"Echo_Combat_Private"`
* `"Social_2.0"`
* `"INVALID GAMETYPE"`
#### `map_name`
Name of the map being played.
Possible values:
* `"mpl_arena_a"` - Standard Echo Arena map
* `"mpl_lobby_b2"` - Lobby
* `mpl_combat_dyson` - Combat maps
* `mpl_combat_combustion`
* `mpl_combat_fission`
* `mpl_combat_gauss`
* `"INVALID LEVEL"`
#### `game_clock`
Current game time in seconds.
#### `game_clock_display`
Current game time as shown in game.
#### `private_match`
Whether the current session is a private lobby.
#### `total_round_count`
Total number of rounds to be played in the match.
#### `blue_round_score`
Total number of rounds that blue has won.
#### `orange_round_score`
Total number of rounds that orange has won.
#### `blue_points`
Number of points blue has scored this round.
#### `orange_points`
Number of points orange has scored this round.
#### `tournament_match`
Whether the current session is being used for an official tournament orchestrated in collaboration with the Echo Arena developers. This is [for possible future integration with ESL and other organized tournaments](https://discordapp.com/channels/326412222119149578/506931756675497986/510566303367430145).
#### `blue_team_restart_request`
Whether or not the blue team is requesting a restart.
#### `orange_team_restart_request`
Whether or not the orange team is requesting a restart.
#### `right_shoulder_pressed`
Touch controller input
#### `right_shoulder_pressed2`
Touch controller input
#### `left_shoulder_pressed`
Touch controller input
#### `left_shoulder_pressed2`
Touch controller input
#### `packet_loss_ratio`
Number of packets missed bu the client out of the total number of packets sent by the server in a 5 second window.
#### `game_status`
The current game's status.
Possible values:
* `"pre_match"`
* `"round_start"`
* `"playing"`
* `"score"`
* `"round_over"`
* `"round_start"`
* `"post_match"`
* `"pre_sudden_death"`
* `"sudden_death"`
* `"post_sudden_death"`
#### `pause`
Details about whether the game is currently paused.
#### `pause.paused_state`
Current pause state of the match.
Possible values:
* `"unpaused"`
* `"unpausing"`
* `"paused"`
* `"paused_requested"`
#### `pause.unpaused_team`
Team that unpaused the game.
Possible values:
* `"orange"`
* `"blue"`
* `"none"`
#### `pause.paused_requested_team`
Team that pressed the pause button.
Possible values:
* `"orange"`
* `"blue"`
* `"none"`
#### `pause.unpaused_timer`
Time until gameplay will resume.
#### `pause.paused_timer`
Time since game was paused.
#### `possession`
Team and player currently in possession of the disc.
`possession[0]` is the team in possession and `possession[1]` is the player in that team.
#### `last_throw`
Info about the last throw made in game by the client user.
#### `last_throw.arm_speed`
Speed of the arm during the last throw.
#### `last_throw.total_speed`
Combination of all speed factors that went into the disc.
#### `last_throw.off_axis_spin_deg`
#### `last_throw.wrist_throw_penalty`
#### `last_throw.rot_per_sec`
#### `last_throw.pot_speed_from_rot`
#### `last_throw.speed_from_arm`
#### `last_throw.speed_from_movement`
#### `last_throw.speed_from_wrist`
#### `last_throw.wrist_align_to_throw_deg`
#### `last_throw.throw_align_to_movement_deg`
#### `last_throw.off_axis_penalty`
#### `last_throw.throw_move_penalty`
#### `last_score`
Last score made in the game.
#### `last_score.disc_speed`
Speed of the disc when it went into the goal.
#### `last_score.team`
Team that scored the last goal.
* `"blue"`
* `"orange"`
#### `last_score.goal_type`
A human-readable explanation of the type of goal scored. This is "[NO GOAL]" by default when no goal has been scored.
Possible values:
* `"[NO GOAL]"`
* `"SLAM DUNK"`
* `"INSIDE SHOT"`
* `"LONG SHOT"`
* `"BOUNCE SHOT"`
* `"LONG BOUNCE SHOT"`
* `"BUMPER_SHOT"` (TBC)
#### `last_score.point_amount`
The number of points scored (2 or 3). This is 0 by default when no goal has been scored.
#### `last_score.distance_thrown`
The distance the goal was scored from. This is 0 by default when no goal has been scored.
#### `last_score.person_scored`
The username of the player who scored the goal. This is `"[INVALID]"` by default when no goal has been scored since you first joined the match.
#### `last_score.assist_scored`
The username of the player who assisted the goal. This is `"[INVALID]"` by default when no goal has been scored since you first joined the match, or when a goal was scored, but no player was credited with the assist.
#### `disc`
An object representing the current state of the disk.
#### `disc.position`
An array representing the disk's position within the arena.
#### `disc.forward`
The direction that the disc is facing.
#### `disc.left`
The direction that the left side of the disc is facing.
#### `disc.up`
The direction that the top of the disc is facing.
#### `disc.velocity`
An array representing the disk's velocity.
#### `disc.bounce_count`
The number of times the disk has bounced. (TODO: Since the last time someone grabbed it? Do headbutts count as bounces?)
#### `player`
An object representing the current state of the local VR player. This is used for positions of the player within their playspace.
#### `player.vr_left`
The direction that the left side of the player's head is facing within their playspace.
#### `player.vr_position`
An array representing the player's position within their playspace.
#### `player.vr_forward`
The direction that the player's head is facing within their playspace.
#### `player.vr_up`
The direction that the top side of the player's head is facing within their playspace.
#### `teams`
An array of objects containing data used to instantiate the game's two teams. The first element in the array is always the blue team, while the second is always the orange team and the third is always the spectators.
#### `teams[].team`
A human-readable team name. Usually either "ORANGE TEAM" or "BLUE TEAM", but if all the players on a team have the same team name (set by pressing F11 while in a match or the lobby) it will be that instead.
#### `teams[].possession`
Indicated whethe this team currently has possession of the disk.
#### `teams[].stats`
An object containing data used to instantiate the team's current stats.
#### `teams[].stats.points`
Points scored by the subject.
#### `teams[].stats.possession_time`
Time in seconds that the subject possessed the disk.
#### `teams[].stats.interceptions`
Number of times the subject intercepted a pass by the opposing team
API always returns zero for teams
#### `teams[].stats.blocks`
Number of times the subject blocked a punch
API always returns zero for teams
#### `teams[].stats.steals`
Number of times the subject stole the disk from the opposing team
#### `teams[].stats.catches`
Number of times the subject successfully caught a pass by a team member
#### `teams[].stats.passes`
Number of times the subject successfully completed a pass
API always returns zero for teams
#### `teams[].stats.saves`
Number of opposing team goals prevented by the subject.
#### `teams[].stats.goals`
Number of goals scored by the subject.
API always returns zero for teams
#### `teams[].stats.stuns`
Number of times the subject has stunned the opposing team.
#### `teams[].stats.assists`
Number of goals assisted by the subject.
#### `teams[].stats.shots_taken`
Number of times the subject attempted a shot on goal
#### `teams[].players`
An array of objects containing data used to instantiate the team's players.
#### `teams[].players[].name`
The username of the player.
#### `teams[].players[].playerid`
A number representing ID of the player within the current game session.
#### `teams[].players[].userid`
A unique number identifying the player across all game sessions.
#### `teams[].players[].number`
The number a player chose for themselves in the customization room.
Need to verify how this works in the new update.
#### `teams[].players[].level`
A number (1-50) representing the player's experience "level". New accounts start as level 1, and will usually reach level 50 after a few hundred games in public matchmaking.
Note that there a rare bug where this number may be 0 in the UI in some cases; it's possible this bug may also affect the API (though this has yet to be verified).
#### `teams[].players[].ping`
Current ping (network latency to server) of this player.
#### `teams[].players[].stunned`
Whether the player is currently stunned.
#### `teams[].players[].invulnerable`
Whether or not the player is currently immune to stuns. Players will be in this state for 3 seconds after they are stunned.
#### `teams[].players[].possession`
Indicates whether this player currently has possession of the disk.
#### `teams[].players[].holding_left`
The item or object the player is holding in their left hand.
Possible values:
* `"disc"`
* player id (`"0"`, `"1"`)
* `"geo"`
#### `teams[].players[].holding_right`
The item or object the player is holding in their right hand.
Possible values:
* `"disc"`
* player id (`"0"`, `"1"`)
* `"geo"`
#### `teams[].players[].blocking`
Whether the player is currently blocking (and will therefore deflect stuns).
#### `teams[].players[].stats`
An object containing data used to instantiate the player's current stats. See [`teams[].stats`](#teamsstats) for a list of available stats.
#### `teams[].players[].velocity`
The current velocity (speed and direction of movement) of the player.
#### `teams[].players[].head`
An object containing position and rotation of the head of the player
#### `teams[].players[].head.position`
The position of the player's head in the arena.
#### `teams[].players[].head.forward`
The direction that the player's head is facing.
#### `teams[].players[].head.left`
The direction that the left side of the player's head is facing.
#### `teams[].players[].head.up`
The direction that the top side of the player's head is facing.
#### `teams[].players[].body`
An object containing position and rotation of the body of the player
#### `teams[].players[].body.position`
The position of the player's body in the arena.
#### `teams[].players[].body.forward`
The direction that the player's body is facing.
#### `teams[].players[].body.left`
The direction that the left side of the player's body is facing.
#### `teams[].players[].body.up`
The direction that the top side of the player's body is facing.
#### `teams[].players[].rhand`
An object containing position and rotation data for the right hand.
#### `teams[].players[].rhand.pos`
The position of the player's right hand within the arena.
#### `teams[].players[].rhand.forward`
The direction that the player's right hand is facing.
#### `teams[].players[].rhand.left`
The direction that the left side of the player's right hand is facing.
#### `teams[].players[].rhand.up`
The direction that the top side of the player's right hand is facing.
#### `teams[].players[].lhand`
An object containing position and rotation data for the left hand.
#### `teams[].players[].lhand.pos`
The position of the player's left hand within the arena.
#### `teams[].players[].lhand.forward`
The direction that the player's left hand is facing.
#### `teams[].players[].lhand.left`
The direction that the left side of the player's left hand is facing.
#### `teams[].players[].lhand.up`
The direction that the top side of the player's left hand is facing.
## Concepts
Throughout the API there are a number of concepts that get reused in multiple places. These concepts are documented in this section.
### Vectors
Position, direction, and velocity are represented within the API as an array of [3D vector coordinates in Cartesian space](https://en.wikipedia.org/wiki/Euclidean_vector#In_Cartesian_space). That's a fancy way of saying the array contains three numbers, each representing a distance/speed in either the left-right (`x`), up-down (`y`), or forward-back (`z`) directions. These directions are arranged as `[x, y, z]` in the arrays returned by the API.
Distance is measured in meters, and speed in meters per second. So, for example, a vector coordinate `[0, 1, 0]` could represent either a distance of 1 meter in the "up" direction, or a speed of 1 meter/second in the "up" direction.
For vectors that contain a mix of several directions, you can calculate the total distance or speed (r) using a 3-dimensional version of the [Pythagorean theorem](https://en.wikipedia.org/wiki/Pythagorean_theorem): r2 = x2 + y2 + z2
In Echo Arena, distances are measured from the center of the Arena, where the disk spawns (at `[0, 0, 0]`). Positive `z` is in the direction of the orange side of the arena, negative `z` is in the direction of the blue side of the arena. If you're on the blue side of the arena facing the orange team's goal, positive `x` would be towards your left, and negative `x` would be to your right (with left/right reversed for a player on the orange team's side of the arena facing the blue team's side). Positive `y` is "up" (relative to a player's orientation when they spawn) and negative `y` is "down".
So, for example, a player located at [10.0, -5.0, -15.0] would be, from the perspective of someone sitting on the blue team's goal facing the orange team's goal, 10 meters to the left of the center of the arena, on the blue team's side, near the floor.
The Arena is 80m long (counting from orange to blue launch tube exits), 30m wide (counting from the widest point of the side walls) and 20m tall (counting from the tallest part of the arena, in the trenches).
### Possession
The API defines "possession" a little more broadly than you might expect (depending on what other sports you may be familiar with that use this term). Not only do players/teams that are currently holding the disk have possession, but teams also maintain possession for 7 seconds after releasing the disk as well, unless the disk is recovered by the opposing team. If the disk is glowing with the color of a specific team, the game considers that team as having "possession".
### Session
A "session" is what users typically think of as the "server" you're playing on. When you join a new match, a new session is created, and the session will remain active until all players leave. Sessions IDs are unique, and have no correspondence to the actual, physical or virtual server hardware that's hosting the game.
## Community parts
This section is for community suggestions and common issues
### Requests
Requests list for additions to the API
* position of the local (remote if networked) player(s) exlcuding irl playspace (position of player using boosts and thrusters and not jumps and ducks)
* private games rules set
### Issues
Issues list for the API
* interceptions are not reported correctly
### Quirks
List of things that don't do quite what you expect but still work
* something like team name isn't always orange or blue
### TODO
Things that need doing in the wiki
* packet_loss_ratio stuff
* bumper_shot confirm
* shoulder_pressed values and description
* fill in last throw values
* add in stuff like `[position](#position-1)`
* Keep updating