Difference between revisions of "Wiimm's Custom Archive/Distribution"
| Line 21: | Line 21: | ||
== Parameters of the configuration file == | == Parameters of the configuration file == | ||
| − | + | ||
| + | The configuration files if divided into 2 parts: | ||
| + | * Parameters | ||
| + | * Track list | ||
| + | Each parameter line begins »'''@'''«. So it can be distinguished from track lines. The order of the lines is irrelevant on scanning, but the out is well organized into sections by comments. | ||
| + | |||
| + | If a parameter is defined multiple times, only the last definition is used. Parameter names are case insensitive. The line length is not limited. | ||
=== Comments for personal use === | === Comments for personal use === | ||
| − | |||
| − | + | The first section consists of user comments (@COMMENT1 .. @COMMENT5). So each user can enter any informational lines, that are exported to the next version of the file. These comments will never imported to ct.wiimm.de. | |
| − | |||
| − | |||
| − | |||
=== Identify yourself! (private section) === | === Identify yourself! (private section) === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | The next section gives yo a chance to identify yourself. It's no problem to leave all parameters empty. But on issues, [[Wiimm]] will use one of theses field to contact you. | |
| − | |||
| − | |||
=== Distribution parameters === | === Distribution parameters === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | The distribution parameters are mandatory identify your distributions. @NAME, @VERSION and @AUTHORS are free text field and mandatory. @RELEASE-DATE is mandatory too and contains the release date of the distribution of format yyyy-mm-dd. | |
| − | |||
| − | |||
| − | + | All 4 parameters of above are used to create a keyword list for your distribution. @KEYWORDS allows you to add some more keywords. All keywords are used for the distribution search. | |
| − | |||
| − | |||
| − | + | With @PREDECESSOR you can identify exact 1 predecessor of this distribution. Predecessor and successors are list at the info page for easier navigation. | |
| − | |||
| − | |||
| − | + | @INFO-TEXT is a free HTML formatted information text and @INFO-URL is a complete link to the main distribution page in the web. Both parameters are optional. | |
| − | |||
| − | |||
=== Settings for ct.wiimm.de === | === Settings for ct.wiimm.de === | ||
??? | ??? | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Automatically created parameters === | === Automatically created parameters === | ||
??? | ??? | ||
| − | + | === User defined parameters === | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
??? | ??? | ||
| − | |||
| − | |||
=== Track listing === | === Track listing === | ||
Revision as of 21:43, 20 November 2017
Wiimm's Custom Archive is a service (website https://ct.wiimm.de/) by Wiimm. It allows an easy access to custom tracks and arena archive. This article focuses at the distribution support of the website.
Introduction
Wiimm's Custom Archive[1] is a download archive for many thousands of custom track files as WBZ. It supports Custom Track Distributions too.
- Features
- List of all supported distributions.
- A distribution info page for each distribution shows some information and also a cup and slot oriented track list. If the track is known, a popup and a link to the track is available.
- Direct download of tracks.
- A custom distribution list is part of the track details.
- The search form supports custom track distributions.
To support a distribution, the user has to download Wiimms SZS Tools version ≥1.55a (≥1.55b recommended) and to execute the command »wszst DISTRIBUTION« (or the short form »wszst dist«). The command scans the tracks and create (or edit) a custom tack definition file. The user has to edit the file and to upload it [2].
wszst DISTRIBUTION
???
Parameters of the configuration file
The configuration files if divided into 2 parts:
- Parameters
- Track list
Each parameter line begins »@«. So it can be distinguished from track lines. The order of the lines is irrelevant on scanning, but the out is well organized into sections by comments.
If a parameter is defined multiple times, only the last definition is used. Parameter names are case insensitive. The line length is not limited.
Comments for personal use
The first section consists of user comments (@COMMENT1 .. @COMMENT5). So each user can enter any informational lines, that are exported to the next version of the file. These comments will never imported to ct.wiimm.de.
Identify yourself! (private section)
The next section gives yo a chance to identify yourself. It's no problem to leave all parameters empty. But on issues, Wiimm will use one of theses field to contact you.
Distribution parameters
The distribution parameters are mandatory identify your distributions. @NAME, @VERSION and @AUTHORS are free text field and mandatory. @RELEASE-DATE is mandatory too and contains the release date of the distribution of format yyyy-mm-dd.
All 4 parameters of above are used to create a keyword list for your distribution. @KEYWORDS allows you to add some more keywords. All keywords are used for the distribution search.
With @PREDECESSOR you can identify exact 1 predecessor of this distribution. Predecessor and successors are list at the info page for easier navigation.
@INFO-TEXT is a free HTML formatted information text and @INFO-URL is a complete link to the main distribution page in the web. Both parameters are optional.
Settings for ct.wiimm.de
???
Automatically created parameters
???
User defined parameters
???
Track listing
???
Tracks unknown by ct.wiimm.de
???