TheLegendofPiratesOnline / documentation

TLOPO Documentation
https://tlopo.com/
Other
4 stars 1 forks source link

Fleet and Invasion Documentation Missing #11

Open Esebranek opened 4 years ago

Esebranek commented 4 years ago

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.

mfwass commented 4 years ago

Hi,

Admittedly, our documentation repository has not been kept as up to date as it should be.

It is on the agenda to spend some time updating this repo in the near future, as well as release a lot of newer APIs that will tie into future expansions.

In the meantime, I recommend referencing this Discord Bot I wrote. It uses all of the APIs referenced above and is a useful sample application.

All the best, Michael

Esebranek commented 4 years ago

Would it be possible to provide an enum of values for the following fields:

Without knowing all of the possible values, it is difficult to map a response such as "fleet": { "started": 1515371588.921096, "shipsRemaining": 1, "state": "deployed", "type": "qar"} to a more readable format.