How To Install 3rd Party Externals For Use in the IDE and Standalone Builder

This lesson will show you how to install an external so that it loads into the Revolution IDE and can be included with a standalone.

Locate The User Extensions Folder

In the Files & Memory preferences pane you can find the full path to the User Extensions folder. Open this folder in your system file browser.

Add External to Externals Folder

In the User Extensions folder (1) there may or may not be an Externals folder. Create the folder if it doesn't exist. Add your external to the Externals folder (2).

Update Externals.txt File

Open the Externals.txt file (1), creating it if necessary. You need to add one line to this file that tells Revolution about your external. The line contains 2 items. The 1st item is the name of your external as it appears in the externalPackages property (2). In this example I'm using the EnhancedQT external so that name is EnhancedQT. The 2nd item is the name of the external file (3). Save the file and close.

Add External To Runtime Folder

Also in your User Extensions folder is a Runtime folder (1) that you can create if necessary. This is where you put the version of the external that should be included when building a standalone application. Place a copy of the external in the platform folders that you want to include (2). Note that for OS X the external is in the Universal folder. That is because the EnhancedQT is a universal binary.

Quick Tip: If you have to create this folder then note the folder structure in this example. The folder structure mimics that of the Runtime folder that sits alongside the Revolution IDE engine.

Update Externals.txt Files

Update the Externals.txt file for each platform.

Check Your Work

Now that you have installed the external launch the Revolution IDE. Type the following in the Message Box:

put the externalPackages of stack "home"

You should see your external listed.

Check the Standalone Builder

When you open the Standalone Settings for a stack your external should be listed.

Build Standalone

If you select your external to be included then when you build a standalone application Revolution will copy the external to the proper locations. Revolution also creates a substack named revExternalLibrary that is attached to the stack you used to build the standalone. If you check the externalPackages of stack "revExternalLibrary" then your external should be listed. Note that this stack is only created when you build the standalone.

Comments (2)

Kirby Glad Monday Jun 17 at 10:57 PM

Very confusing directions. It shows the extensions folder as "My Revolution Enterprise" but the next step says to put the external in the folder External. It talks about adding a .bundle file, but the external I purchased doesn't have a .bundle file. Do I then add the same files to the Runtime folder? Why does it need to be in two folders? etc. etc.

Elanor Buchanan Thursday Jun 27 at 03:16 AM

Hi Kirby

Thanks for pointing this out, we have updated the lesson to point at the My LiveCode folder.

The first step just allows you to find out where that folder is, you then need to go to that folder in your system file browser, within that folder check to see if there is an Externals folder, if not you need to create it. You should then be able to follow the rest of the steps in the lesson.

I hope that helps.

Kind regards

Elanor

Add your comment

E-Mail me when someone replies to this comment