You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/start/tool.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
There are a few things that all tools must conform to for Renoise to successfully recognize and load them.
4
4
5
5
```sh
6
-
com.name_of_creator.name_of_tool.xrnx
6
+
com.domain_of_developer.name_of_tool.xrnx
7
7
├── manifest.xml
8
8
├── main.lua
9
9
├── cover.png
@@ -24,11 +24,11 @@ A tool is a folder or a *zip file* with the extension `.xrnx`.
24
24
*`README.md` is a markdown-formatted file that the website will render on the tool's page.
25
25
*`LICENSE` is a raw text license file.
26
26
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.
28
28
29
29
30
30
> [!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.
32
32
33
33
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.
34
34
@@ -46,7 +46,7 @@ Here is an entire manifest file from a HelloWorld tool:
0 commit comments