(It wasn’t clear to me how to do this, so I wrote this. Updated for publishing)
XOD 0.16.0 added a way to share libraries.
Get A Library
- You need the exact, full-name of the library.
- Either you know it already (“Hey! Use my cool nkrkv/my-utils”), or visit https://xod.io/libs/, and look for a library. You need the two-part name, like dox/lcd-button-shield
- Run XOD (desktop)
- In File, choose “Add Library”
- A search box should appear and ask you to “type owner/library…” That’s the two-part name.
- As you type, it should search, and find it. (There seems to be a bug at the moment, pasting won’t work unless you also type something).
- Hit return, and it will install it. Look in your “libraries” list, just like the usual “xod/” libraries.
Publish A Library
You actually publish a project as a library.
- Develop your library as a regular project. The name of your project becomes the library name: yourloginname/projectname. E.g. my project “MIDI” will become “awgrover/MIDI”.
- Create patches as appropriate. A patch becomes a node that someone can use from your library. E.g., I made a “note” and “program-change” patch. Those become
- Document your patches nicely. Fill in the description for the patch and all the inputs and outputs. Check by dragging the patch into “main” and using “h” to turn on the side panel that “documents” a node. The descriptions will show up when someone browses your library at https://xod.io/libs/
- Delete your “main” patch. Instead, make “example” patches to show how to use your library nodes (is this a good idea?).
- Set the project-preferences, the description is your library description.
You need an “account”. That means a forum.xod.io account
- Make an account if you don’t have one:
1.1. Got to https://forum.xod.io/, click “login” and “sign up”.
1.2. Actually, accounts are managed by https://xod.io/auth/, you could just go there.
1.3. So, “forum”, “library”, “cloud compile” accounts are the same thing.
- Run XOD
- Login (inside of XOD-IDE). In the View menu, choose “Toggle Account Pane”. Now you get a place to type the username and password.
- You can “toggle” again to hide the pane after you log in.
Publish Libraryfrom the
- It will only take a second
- See it on https://xod.io/libs
Right now, your library is a project on your own system, so you probably want to make it into a library for yourself.