So you’re writing an interface and you make some useful routines and then you realize that you’d like to use this library in other components.
How do you do this?
You can create libraries which are then re-usable from any other Iguana X component.
Assuming you already have Installation taken care of.
Components are created in the Dashboard, using the the [+COMPONENT] button.
You can click on Learn More in the component description to access its documentation. All of the iNTERFACEWARE Collections components are documented for your reference.
Select a component
Name your component
Add Tags
Click to Add the component
Notice you can also filter the components displayed by Collection - use the All Collections dropdown to select the Collection you want to display.
Tags are used to categorize and add functionality to components. For example, #autostart is used by IguanaX to determine if components should be automatically started when the IguanaX server starts up.
See Component Cards for more information.
Many components have Custom Fields which you can edit and set by clicking the ellipsis beside each one. The idea is that many components need to be configured for the environment they are in without the need to fully Edit a Component.
You can start and stop components using the button in the top left corner:
You can also do it from the list of components on the left of the dashboard and using Bulk Actions in the dashboard.
When one component feeds into another component, it’s linked by a queue where data is securely stored on disc and fed into the next component. Click Edit Connections and follow the steps here: Edit Connections.
That shows the core operation of IguanaX. The real power comes from being able to Edit a Component.
Click the Create Folder icon
Enter the folder name and click and click the green [CREATE] button
You should see something like this:
Select the Create File menu optin on the FOO folder
Enter the folder name and click and click the green [CREATE] button
Create a function in the BAR.lua file, you can paste this example:
function FOObar() return "The world needs more FOO"; end
You should see something like this:
Click the Commit changes toolbar button
The commit dialogue will open, enter a commit message and click the green [COMMIT] button
Click the Push changes to remote toolbar button
The upstream repository will look something like this:
NOTE: FOO is currently just a folder
Open the folder menu by right clicking on FOO, or clicking the 3 dot menu
Choose Create Library to convert the FOO folder into a Library
Click the green [CREATE] button in the confirmation dialogue
This will bring you to the Repository Management dialogue
Once you are in the Repository Management screen you can set your upstream repository
Enter the name (also called a slug) for the repository
To create a new repository enter a repo name (slug) that does not exist yet
Click the [CONFIRM CHANGE] button to connect or create
It is possible to connect to an existing repository in the Repository Management dialogue – but we strongly recommend against this as there a few, if any, scenarios where this would be useful.
See Step 5 for detailed screenshots (the first three steps below are the same)
Click the Commit changes toolbar button
The commit dialogue will open, enter a commit message and click the green [COMMIT] button
Click the Push changes to remote toolbar button
The component upstream repository will look something like this:
NOTE: Notice that FOO was converted from a folder (in step 3) to a reference to the FOO library
The FOO library upstream repository will look something like this:
NOTE: That the the FOO library should have the BAR.lua file in it.
Get the FOO library URL
Choose View Remote menu option for the FOO library
Right click on the URL to copy URL
Edit the target component in the Translator
This is the component you will add the FOO library into
Click the Add library button to open the Import Library dialogue
Enter the FOO library details in the LIBRARY DETAILS section of the Import Library dialogue
Type in the library name FOO
Paste the URL you copied above into the GIT url field
Click the green [IMPORT] button to import the library
You can also add your libraries to a collection so they will show up in the Import Library dialogue list.
Choose the Add to Collection option from the right click menu
Choose an existing collection or create a new collection in the Add to collection dialogue
If you choose an existing collection your library will immediately show in the Import Library list
If you create a new collection you will need to add it to Settings → Git Collection
In this example I will choose an existing collection Test Lib collection
This will open the Edit Collection dialogue for the chosen collection
Here I can edit the details for libraries in this collection
In this case I will just update the description for FOO
Click the green [SAVE] button to add the new library
Now when I open the Add Library dialogue and filter for FOO it is there in the list
