Quickstart guide

Rustici Driver works across the board with almost any eLearning specification. In order to make it easy for you to use Driver for free, we ask that you pick which specification you want to use.

Which specification do I need?

That depends on your LMS. Find out what specs your LMS accepts, and then match that spec to the download of Rustici Driver. It’s most likely SCORM or AICC. If in doubt, choose SCORM 1.2.

Here are the options that you have:

• SCORM 1.2
• SCORM 2004 2nd Edition
• SCORM 2004 3rd Edition
• SCORM 2004 4th Edition
• xAPI (also known as the Experience xAPI or Tin Can API)
• AICC

Get your free copy of Rustici Driver for non-commercial use

Once we receive your request via our form, we’ll send an email with the download link to your inbox.

What am I downloading?

When you receive the link via email to download Driver for whatever specification you need, you’ll be downloading a zip file that contains a template for the standards package you selected. To use Rustici Driver’s free version for non-commercial use, all you need to do is change some of the template to reflect your content, insert your content, and then let our Driver javascript do the heavy lifting for you.

Can I still try it if I don’t have a course to test with?

Yep. We created a very basic sample course that has zero SCORM/xAPI/AICC conformance. If you’d like to experiment with making it conformant via this Quickstart Guide, you can download it here.

If you want to see how this sample course looks after it has become SCORM/xAPI/AICC conformant with Rustici Driver, you can download the appropriate files here:

• Sample Course – SCORM 1.2
• Sample Course – SCORM 2004 3rd Edition
• Sample Course – SCORM 2004 4th Edition
• Sample Course – xAPI
• Sample Course – AICC

In the root folder of the Rustici Driver package that you just downloaded, you’ll see some files. They’ll be different depending on what specification you chose, but this step is similar for all specs.

Software you might need

You’ll need a text editor to modify the files that you’ll be editing. Some text editing programs will attempt to display the files as web pages instead of text, so we recommend using Sublime Text as it works for both Mac and Windows machines.

Below, we’ve outlined the next steps for SCORM, AICC and xAPI.

First step for all versions of SCORM

For SCORM, you should see a file in the root folder called imsmanifest.xml. You can ignore all other files at this time, and open up imsmanifest.xml with your favorite text editor (Sublime Text).

You’ll see the code contained in this file, but we’re only concerned with two small bits — the text that’s in between the two “Title” tags.

Just change the “Titles” that you see circled here to the name of your content as you want it to be displayed in your LMS. Re-save the imsmanifest.xml file after you’ve made your changes, and you’re done with this step for SCORM.

You’ll also want to update the “Resources” list inside the imsmanifest.xml file. This is basically any file or asset that is used in your course. It includes files that are used by Rustici Driver as well as HTML, images, movies, Flash or any other assets used in your course. If you downloaded our sample course, then the Resources section of your imsmanifest file will look like this:

You want to replace the highlighted section in the imsmanifest file with the assets that make up your course. If it’s not highlighted in the image above, leave it as it is. Save the imsmanifest.xml file, and you’re done with the this part.

First steps for AICC

The process is similar if you’ve chosen AICC as your specification. At this point, you can ignore all files in the root directory except for yourcourse.au and yourcourse.crs. Open these files with your favorite text editor (Sublime Text) and you’ll change just a few lines of text in the files.

yourcourse.au

If your content and your LMS are all on the same domain (cloud.scorm.com for example,) you can skip editing this file and go right down to editing yourcourse.crs. If your content is being hosted on a different domain than your LMS (cross domain), then you’ll need to replace “scormdriver/indexAPI.html” to “http://YourDomainName.com/YourSubFolder/indexAPI.html”. Re-save this file, and move on to the yourcourse.crs file.

yourcourse.crs

This file is the easiest of all. Make sure it’s open in your text editor, change the “Title” on the 5th line of the file to the title of your course, re-save the file, and you’re done.

First steps for xAPI (Experience API or Tin Can API)

After you’ve downloaded Rustici Driver with xAPI support, you’ll need to modify two files that are found in the root directory of the download.

tincan.xml

The first is “tincan.xml”. Open the file in your text editor, and change the following lines:

Here’s what to modify in tincan.xml:

• –ActivityID– : This is the object of the xAPI statement. It’s usually a URL. You can use whatever you want here, just make it something that makes your activity uniquely identifiable.
• –ActivityName– : Replace this with the title of your course or activity.
• –ActivityDesc– : Replace this with a very brief description of your activity.

After you’ve made your modifications, save your file.

tc-config.js

The other file you need to modify for the xAPI use is tc-config.js, also found in the root directory of your download. Open it in your text editor, and pay attention to the following code:

Here’s what to modify in tc-config.js (it’s largely similar to how you updated tincan.xml):

• –ActivityID– : This is the object of the xAPI statement. It’s usually a URL. You can use whatever you want here, just make it something that makes your activity uniquely identifiable.
• –ActivityName– : Replace this with the title of your course or activity.
• –ActivityDesc– : Replace this with a very brief description of your activity.

Now, the current configuration will allow you to create a xAPI package that will send statements to the LRS of whichever xAPI-enabled LMS you import it into. However, you have the option of sending statements to more than one LRS at a time. To demonstrate this, look for the two tiny circles in the screenshot above. Just delete the /* and the */ in the bottom of the tc-config.js, and when you launch your xAPI course, you’ll be generating statements to your LMS as well as to our public LRS. Make sure to check our public LRS after you’ve generated statements in this way. You can see your statements in your LMS and in our public LRS.

If you don’t delete the /* and */ as mentioned above, you’ll only generate statements to the LRS of the LMS that you imported your content to.

After you’ve made your modifications, save your file and move on to the next step.

This process is the same for xAPI, AICC and all versions of SCORM. You should already have your course created — your HTML, your movies, images, whatever you have. Take all of the files that comprise your course, and drop them in the “scormcontent” folder inside the Rustici Driver file system. Note what the filename is for the first page of your course- you’ll need it for the next step.

NOTE: you shouldn’t drop just one folder that contains your files into the “scormcontent” folder, you should drop your actual HTML and content files into the “scormcontent” folder.

Ack! I don’t have any content to test with!

We have a sample course that has zero SCORM/xAPI/AICC conformance, and you can download it here.

Find the indexAPI.html file in the scormdriver folder. Open it in your text editor, and find the code that you see here:

The only thing that you want to change in this file is “index.html”. Look back at the files you just copied into the “scormcontent” folder, and note the file name of the first page of your course. Change “index.html” inside the indexAPI.html file to that file name. If the file name is “training1.html” in your “scormcontent” folder, then just replace the text “index.html” with the text “training1.html”. It’s important for your file name to not have any spaces in it.

Note: this is different from the “course title” that you changed in your “imsmanifest.xml” file or your “yourcourse.crs” file. This is the actual name of the first file in your course. To double check, look back in the “scormcontent” folder and see the file name of the first file in your course.

Re-save your file.

Your course is now technically SCORM, xAPI or AICC (whichever you chose) conformant! We don’t want to stop here, though. We should add bookmarking and completion to your course. It’s easy to do…just hit the “next” button.

If you know basic HTML, then this step will be a breeze for you. If not, then we’ll try to make it as easy as possible for you.

Bookmarking Code

You’ll need to add some bookmarking code to the pages of your course so that a learner’s location within your course can be tracked and recalled.

Go back to the “scormcontent” folder from the root of the Driver folder, and find all of the HTML files that are a part of your course. Open the first HTML file of your course with your text editor, and you should see lots of HTML code.

Look for the closing HEAD tag. Note: there are two HEAD tags. The opening HEAD tag has no “/” in it. The closing HEAD tag has a “/” in it.

It should look like this:

Once you’ve found the closing HEAD tag, you need to paste the bookmarking code just above that tag. Here’s the bookmarking code to copy/paste into your file:

<script type='text/javascript' src='../scormdriver/auto-scripts/AutoBookmark.js'></script>

If you did it correctly, your final code should look something like this:

Re-save your file, and you’ve now added bookmarking to that page. Repeat the process for every HTML page that’s a part of your course. Now you’re ready to add completion code.

Completion Code

This is very similar to adding bookmarking code, except completion code is only added to the very last page of your course — the page that says something like “Congratulations, you’re done!”

You’ll add this completion code directly above the bookmarking code that should already be in place (copy/paste this):

<script type='text/javascript' src='../scormdriver/auto-scripts/AutoCompleteSCO.js'></script>

So, the final code on your “completed” page should look like this:

Re-save this last file, and you’re done with this step.

Others

If you want to add other SCORM functionality to your course, there’s plenty that can be done. It’s a fair assumption that if you know that you want to add more, then you probably have a decent understanding of HTML and javascript (at least we’re going to assume that.) You can find all of the other SCORM functions that can be added to your course in the more detailed Rustici Driver documentation. Or if you’re looking to add other activity statements, check out our xAPI developer resources page.

The last thing you need to do is create a ZIP file out of the entire thing. The important part here is that you don’t want to zip that one folder that contains all of your files — you want to zip the entire contents of the root directory. The root directory is the one that contains the imsmanifest.xml file or the yourcourse.au/yourcourse.crs files. When the package is unzipped, it should show the contents of the root folder (not a folder that contains the contents of the root folder.)

Creating your ZIP in Windows

On a Windows machine, navigate to the root folder of Rustici Driver. This is the folder that contains the imsmanifest.xml file or the yourcourse.au/yourcourse.crs files. Select all of the files and folders (keyboard shortcut ctrl+a), right click on one of the files and select “send to”, then “compressed ZIP folder”. This zip file is now ready to be imported to an LMS!

Creating your ZIP on a Mac

Find the root folder of Rustici Driver. This is the folder that contains the imsmanifest.xml file or the yourcourse.au/yourcourse.crs files. Select all of the files and folders by pressing command+a on the keyboard, then right click on one of the files and select “compress (n) items”. This creates a zip file that’s ready to be imported to an LMS!

Test your course

If you want to test out your course, then SCORM Cloud is the perfect place to do that. Plus, a SCORM Cloud trial account is free and you can sign up here.

You’re finished. Delightful!