Code Monkey home page Code Monkey logo

documentation's Introduction

documentation's People

Contributors

bartgunshot avatar dependabot[bot] avatar esebranek avatar jfoulroberts avatar johnnydapirate avatar loblao avatar lungyiing avatar mfwass avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

c0mpu73r

documentation's Issues

Download Documentation/API Implementation

The API documentation does not provide any information on downloads, yet provides information on logging in which seems to be an oversight/omission. It seems that download requests are done through download.tlopo.com rather than through the API. I'm unsure if there were plans to include API requests for downloading through the API as well, if so maybe that's the reason for the omission.

Regardless, including the relevant download documentation for downloading/updating the game in the API docs would be beneficial.

Expose player location data

As a consumer of the TLOPO API I would like the ability to retrieve a population breakdown by location for any given shard.

Use case:
A user is switching servers to sail on a less populated server. This information will help inform their decision and prevent switching to an ocean where the majority of the population is sailing.

Example:

GET <api>/shards/<shard_id>

{
  "locations": [
    {
      "location_id": 123,
      "location_name": "Tortuga",
      "population": 12
    }, ...
  ]
}

If you were willing to expose player information as well that could be included in this endpoint.

GET <api>/shards/<shard_id>

{
  "locations": [
    {
      "location_id": 123,
      "location_name": "Tortuga",
      "players": [
        {
          "player_id": 123,
          "player_name": "John",
          "guild_id": 456,
          "guild_name": "Some Guild",
          ...
        }, ...
      ]
    }, ...
  ]
}

Without knowing the underlying architecture I can't advocate for a specific format, but I would prefer to receive more information up front versus making numerous requests per resource.

Fleet and Invasion Documentation Missing

The Ocean API Ocean Information section has several incomplete fields. The Fleet subsection is mostly complete, but lacks helpful documentation on the fields Type and State. The Invasions subsection still mentions that the feature is under development. Invasions are now part of the game, but there has not been an update to this API/documentation. Please provide more detail in these sections as possible.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.