From 5a1656b8d006335d259db82ebd281c37105944ed Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Tue, 26 Jan 2021 17:35:06 +0000 Subject: [PATCH] Add more information to minetest_client.md --- docs/minetest_client.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/minetest_client.md b/docs/minetest_client.md index e2feb55c..ec1f42cd 100644 --- a/docs/minetest_client.md +++ b/docs/minetest_client.md @@ -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: @@ -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`.