Skip to content

Commit af37253

Browse files
unlessgamesemuell
authored andcommitted
update categories, fix typo, clean up id/domain
1 parent c50fe6a commit af37253

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/start/tool.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
There are a few things that all tools must conform to for Renoise to successfully recognize and load them.
44

55
```sh
6-
com.name_of_creator.name_of_tool.xrnx
6+
com.domain_of_developer.name_of_tool.xrnx
77
├── manifest.xml
88
├── main.lua
99
├── cover.png
@@ -24,11 +24,11 @@ A tool is a folder or a *zip file* with the extension `.xrnx`.
2424
* `README.md` is a markdown-formatted file that the website will render on the tool's page.
2525
* `LICENSE` is a raw text license file.
2626

27-
The paths to the cover, thumbnail, readme, and license files can be customized using the `...File` tags in the manifest. See below for more info.
27+
The paths to the cover, thumbnail, readme, and license files can be customized using the `...Path` tags in the manifest. See below for more info.
2828

2929

3030
> [!NOTE]
31-
> You'll see that the names of tool folders follow [reverse domain notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation), but don't worry, you don't have to actually own a domain to create and share your tools. Just use whatever nickname you want, but make sure it's not already taken by other developers to avoid confusion.
31+
> You'll see that the names of tool folders (and `Id` field) follow [reverse domain notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation), but don't worry, you don't have to actually own a domain to create and share your tools. Just use whatever nickname you want, but make sure it's not already taken by other developers to avoid confusion.
3232
3333
If needed, you can split your tool into multiple files and use the ["require" function](https://www.lua.org/pil/8.1.html) to load them inside your main script, but to start with, you will be fine just using a single main script.
3434

@@ -46,7 +46,7 @@ Here is an entire manifest file from a HelloWorld tool:
4646
<?xml version="1.0" encoding="UTF-8"?>
4747
<RenoiseScriptingTool doc_version="0">
4848
<!-- REQUIRED -->
49-
<Id>com.renoise.HelloWorld</Id>
49+
<Id>com.yourDomain.HelloWorld</Id>
5050
<ApiVersion>6.2</ApiVersion>
5151
<Version>1.02</Version>
5252
<Author>Your Name [[email protected]]</Author>
@@ -100,8 +100,7 @@ Let's go through what each of these tags means and what you should put inside th
100100
* `<Documentation>` A URL to a website where your tool's documentation can be viewed.
101101

102102
#### Tool Categories
103-
104-
Valid categories are: `Automation`, `Coding`, `Control`, `Development`, `Export`, `Game`, `Hardware`, `Import`, `Instrument`, `MIDI`, `Mixing`, `Modulation`, `Networking`, `OSC`, `Pattern Editor`, `Pattern`, `Phrases`, `Plugins`, `Recording`, `Rendering`, `Sample Editor`, `Sample` , `Sequencer`, `Slicing`, `Tuning`, `Workflow`
103+
Valid categories are: `Analysis`,`Automation`,`Bridge`,`Coding`,`Control`,`Development`,`DSP`,`Editing`,`Export`,`Game`,`Generator`,`Hardware`,`Import`,`Instrument`,`Integration`,`Live`,`MIDI`,`Mixing`,`Modulation`,`Networking`,`OSC`,`Pattern`,`Phrase`,`Plugin`,`Recording`,`Rendering`,`Sample`,`Sequencer`,`Slicing`,`Tuning`,`Workflow`
105104

106105
#### XML Text Encoding
107106

0 commit comments

Comments
 (0)