Mirrorlandia_minetest/contentdb
1
0
Fork 0
mirror of https://github.com/minetest/contentdb.git synced 2024-12-31 10:17:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add more information to minetest_client.md

Browse Source
This commit is contained in:
rubenwardy 2021-01-26 17:35:06 +00:00
parent 8fad3a15cd
commit 5a1656b8d0
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/minetest_client.md
View File

@ -6,12 +6,11 @@ or for implementing ContentDB compatible servers.
## Package List API call
The first request the client makes is to `/api/packages/`.
The client will provide a list of supported types, the current engine version information,
and any hidden [Content Flags](https://content.minetest.net/help/content_flags/).
The client makes a single [API](https://content.minetest.net/help/api/) request to `/api/packages/`.
Because the client specifies the engine version information, the response must contain a release
number and the package must be downloadable.
The query arguments will include a list of supported types, the current
[engine version](https://content.minetest.net/api/minetest_versions/),
and any hidden [Content Flags](https://content.minetest.net/help/content_flags/).
Example URL:
<https://content.minetest.net/api/packages/?type=mod&type=game&type=txp&protocol_version=39&engine_version=5.3.0&hide=nonfree&hide=desktop_default>
@ -32,6 +31,16 @@ Example response:
]
```
`thumbnail` is optional, but all other fields are required.
`type` is one of `mod`, `game`, or `txp`.
`release` is the release ID. Newer releases have higher IDs.
Minetest compares this ID to a locally stored version to detect whether a package has updates.
Because the client specifies the engine version information, the response must contain a release
number and the package must be downloadable.
## Screenshots
The client can simply download the URL mentioned in `thumbnail`.