Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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.

 Add a component using green [+ COMPONENT] button

Create a Component

Assuming you already have Installation taken care of.

Components are created in the Dashboard, using the the [+COMPONENT] button.

 STEP 1: Go to the dashboard and click +Component
image-20231117-212034.png
 STEP 2: Select a component, name it and describe it

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.

  1. Select a component

  2. Name your component

  3. Add Tags

  4. 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.

 STEP 3: Click on the component to open its component card - note the Name, Description and Tags

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.

 STEP 4: Configure custom fields on the component

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.

 STEP 5: Stop and start the component using the button in the top left corner of the card

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.

 STEP 6: Link the components together

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.

 Make sure it has an upstream repo

Set an upstream repository & Set upstream Git repo

Unable to render {include} The included page could not be found.
 Create a directory FOO
  • Click the Create Folder icon

  • Enter the folder name and click and click the green [CREATE] button

  • You should see something like this:

 Create a file BAR.lua in the directory with a function
  • 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:

 Commit the changes and push them to the upstream repo
  • 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

 Right click and convert FOO to a library

 Commit and push

If you look at the FOO library it should have the BAR.lua file in it.

If you look at the repo for the component it should have the link to the library in it. It doesn’t currently - there is a bug.

 Now create a new component + FROM URL based on the git repo of this library

Bang - this work flow is currently broken as of 10.1.80

  • No labels