Difference between revisions of "Documenting your artefacts"
From Elite Wiki
(Created page with "Once you created an OXP and want to show it to the world, you probably want to advertize the expansion's features. But players may also need some knowledge about the ships or...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
* Mandatory: At least create a wiki page with the page title identical to the expansion's name (as mentioned in the manifest, not the filename). | * Mandatory: At least create a wiki page with the page title identical to the expansion's name (as mentioned in the manifest, not the filename). | ||
* Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title. | * Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title. | ||
| + | * Automatic installation: Wrap your OXP into an OXZ and publish it on the [https://github.com/OoliteProject/oolite-expansion-catalog expansions catalog]. This will allow the Oolite builtin expansions manager or the [[Oolite Starter]] to offer and install your expansion. | ||
| − | The [[ | + | The [[Oolite Documentation Project]] is trying to cleanup technical debt in this respect. |
Latest revision as of 11:50, 4 February 2024
Once you created an OXP and want to show it to the world, you probably want to advertize the expansion's features. But players may also need some knowledge about the ships or equipment that you created. For example, if you create a new equipment type foo others will want to know what it is, what it does and how to use it. So how to do it?
- Mandatory: At least create a wiki page with the page title identical to the expansion's name (as mentioned in the manifest, not the filename).
- Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title.
- Automatic installation: Wrap your OXP into an OXZ and publish it on the expansions catalog. This will allow the Oolite builtin expansions manager or the Oolite Starter to offer and install your expansion.
The Oolite Documentation Project is trying to cleanup technical debt in this respect.
