-
Notifications
You must be signed in to change notification settings - Fork 17
Frequently Asked Questions
This page is meant to answer any questions about scorm4unity. If you don't see your question here, you can edit this page or file an issue and we will respond as quickly as possible.
SCORM is the de facto e-learning standard for packaging content, communication between content and an LMS, and content sequencing. SCORM enables interoperability between e-learning content and learning management systems (LMS).
The Unity-SCORM Integration Kit is a Research and Development project funded by the US. Department of Defense Advanced Distributed Learning Initiative. It allows simulations, built in Unity and hosted by the Unity WebPlayer, to be imported, launched, and tracked in an LMS.
Download the file from the Unity Asset Store or from the ADL website at ADLnet.gov. You should receive a file called UnityScormIntegration.unitypackage.
The Unity-SCORM Integration Kit will need to be imported into each of your Unity projects. In the main Unity GUI, choose Assets on the top menu, then select Import Package, and click Custom Package. Browse to and select the UnityScormIntegration.unitypackage file. In the dialog that appears, make sure all the check boxes are checked, then click Import. This will copy the necessary files into a folder called ADL in your assets folder.
The Unity-SCORM Integration Kit contains code that will add some menu options to your main menu. If you have just imported the package and do not see SCORM on your main menu, try clicking the File menu to force the menu bar to refresh. From this menu, select Create SCORM Manager. You should see a message that a ScormManager prefab has been added to your scene. In your scripts, you can type ScormManager.GetLearnerName() or other functions when the ScormManager has finished its initialization process.
SCORM does not specify how or when you decide that your training has been successfully completed. It’s up to you and your instructional designers to determine when students have passed, what their score is, and what interactions are tracked by the system.
You should be able to see a list of the available functions by typing ScormManager followed by a period in the MonoDevelop GUI. These functions have descriptive names and metadata describing their function. You can view the source of the ScormManager.cs file for more information on how these functions work, and what they do.
I need to manipulate the data model in a way that is not exposed by the ScormManager. Is there a way to access the student data directly?
Yes. Call ScormManager. GetLearnerRecord(). This will return a data object that has all of the SCORM data model elements available. Be careful – you’ll need to know the meaning of the SCORM terminology to make good use of this.
How do I know what all these terms mean? I see things like Entry, TimeLimitAction… Are these documented somewhere?
Of course. You can read the official SCORM Documentation at the SCORM ‘Resources’ Tab
How do I know when the ScormManager’s initialization is complete, so I can begin communicating with it?
The ScormManager Gameobject will send a message to its children when it is ready to receive commands. This message is Scorm_Initialize_Complete. The ScormManager will begin its startup procedure automatically. Be sure to place objects that need to access the ScormManager under it in the scene hierarchy, so that they may receive the startup message. Typical startup times in our testing range from 1 to 3 seconds.
SCORM simulations must be hosted by the Unity WebPlayer and launched from the LMS to track SCORM data. There is currently no standardized way to connect a desktop executable file to a SCORM LMS. Contact ADL for advice if you cannot use the Unity WebPlayer. This integration kit is intended to work with the Unity WebPlayer only.
First, make sure that you selected that SCORM WebPlayer template. The SCORM system depends on some JavaScript libraries that will not be available on the standard WebPlayer template. Once you have published as a WebPlayer, note the location of the files. These should be in a folder called WebPlayer within the output folder you selected when publishing. This folder will need to be packaged in a SCORM Content Package before it can be uploaded to your LMS. We have provided a tool to create a basic content package from within the Unity GUI.
You should have a menu item on your main menu titled SCORM. Select this menu, and then select Export SCORM Package. You should see a dialog like the one shown here. The tool provides a lot of feedback on the various options, and you can get an explanation by holding your mouse over a term. Be sure to select the folder where you published the WebPlayer. When you have filled out the data, choose publish at the bottom. This will export a .zip file with the proper format to upload to a SCORM LMS.
I’m fairly good with SCORM, and would like to set up more complex sequencing rules. Can I do this through the GUI?
There is currently no support for other sequencing rules in the GUI. Instead, open the content package that is exported and locate the imsmanifest.xml. You can add your sequencing rules or other packaging options here. The ADL RELOAD Editor Version 1.1 can be used to edit a SCORM package. RELOAD is available at the SCORM ‘Resources’ Tab.
First, check that you exported to the SCORM WebPlayer template. This template includes JavaScript libraries that are necessary for the SCORM/Unity integration to work. Second, ensure that the SCORM package was imported into an LMS. The SCORM/Unity integration will not work when launching the course off of your local computer with your browser – it must be delivered via the LMS. For basic testing, you can use the ScormSimulator JavaScript file. This will simulate the LMS run-time environment although you will have no control over the ‘fake’ data that the simulator provides, nor will the simulator actually store data you submit. To use the simulator, uncomment the appropriate line at the bottom of ScormSimulator.js in the /assets/webplayertemplates/scorm/scripts/ folder. Publish your WebPlayer and run locally. Remember to re-comment this line before you publish your final course, or the integration kit will send data to the simulator instead of the real LMS.
I need to run the WebPlayer locally in order to troubleshoot my code. However, my simulation never starts because I never receive the Scorm_Initialization_Complete message.
For basic testing, you can use the ScormSimulator JavaScript file. This will simulate the LMS run-time environment although you will have no control over the ‘fake’ data that the simulator provides, nor will the simulator actually store data you submit. To use the simulator, uncomment the appropriate line at the bottom of ScormSimulator.js in the /assets/webplayertemplates/scorm/scripts/ folder. Publish your WebPlayer and run locally. Remember to re-comment this line before you publish your final course, or the integration kit will send data to the simulator instead of the real LMS.
I have a custom WebPlayer template with slick graphics, and I don’t want to use yours. Can I do this?
Sure. Just be sure to include scorm.js in your webplayer.html file. This file can be found in /assets/webplayertemplates/scorm/scripts.
When I close the simulation, no data is saved. How do I make sure that the data I send to the ScormManager is saved to the LMS?
You need to call ScormManager.Commit(); before closing the simulation. This process takes a few seconds to complete, during which we suggest you show some sort of GUI page. When the Unity SCORM Integration Kit has saved all the data to the LMS, it will send the message Scorm_Commit_Complete. Be sure not to close the Unity WebPlayer until this process has finished. If you think the user might close the window without exiting your simulation correctly, you can periodically call ScormManager.Commit() while your simulation is running. It launches a separate thread and will not pause or block your game.