No edit summary |
|||
| Line 31: | Line 31: | ||
* https://github.com/williamjacksn/tilde-description-protocol | * https://github.com/williamjacksn/tilde-description-protocol | ||
* [https://tilde.team/~ben/tilde.json/|ben's tilde.json explorer] | * [https://tilde.team/~ben/tilde.json/|ben's tilde.json explorer] | ||
* [https://tildegit.org/team/site/src/commit/16e6e4aa092a83cb70c0145db0a3c01aafdac9c3/gen_tdp|example tilde. | * [https://tildegit.org/team/site/src/commit/16e6e4aa092a83cb70c0145db0a3c01aafdac9c3/gen_tdp|example tilde.team's generator script in python] | ||
* [https://git.tilde.town/tildetown/townstats/src/commit/6644d7a806725fe4e123990aade6261f1e2944be/main.go#L58-L65|town additions to the protocol] | * [https://git.tilde.town/tildetown/townstats/src/commit/6644d7a806725fe4e123990aade6261f1e2944be/main.go#L58-L65|town tilde.town's additions to the protocol] | ||
Revision as of 22:58, 3 June 2021
tilde.json is a schema used to share info about a Tilde.
Retrieved http://protocol.club/~datagrok/beta-wiki/tdp.html from archive.org [1]
Tilde Description Protocol
William Jackson (william@protocol.club) - Thu Dec 11 12:51:47 2014
Abstract
The Tilde Description Protocol (~dp) defines a JSON document structure for providing general information about a tilde.club-like server and its users.
Document Location
The ~dp document MUST be named tilde.json and MUST reside in the web root of the server that is described by the document. For example, the ~dp document for protocol.club MUST be accessible at http://protocol.club/tilde.json.
Document Structure
The ~dp document SHOULD be a valid JSON document that contains a single object with the following fields:
- name: (string) the name of the server.
- url: (string) the URL of the server.
- signup_url: (string) the URL of a page describing the process required to request an account on the server.
- user_count: (number) the number of users currently registered on the server.
- want_users: (boolean) whether the server is currently accepting new user requests.
- admin_email: (string) the email address of the primary server administrator.
- description: (string) a free-form description for the server.
- users: (array) an array of users on the server. Each object in the array SHOULD contain the following fields:
- username: (string) the username of the user.
- title: (string) the HTML title of the user’s index.html page.
- mtime: (number) a timestamp representing the last time the user’s index.html was modified.