SkookumScript UE4 Plugin installation and setup

You must have the Unreal Engine installed on your system before you can install the SkookumScript Unreal Engine 4 Plugin. (Install Unreal Engine)

Epic Games Launcher users

First-time install

  1. Run the Epic Games Launcher.
  2. Under the Unreal Engine tab, click Marketplace. In the search box, type SkookumScript.
  3. The SkookumScript logo should appear; click it to go to SkookumScript Content Detail page.
  4. Scroll down and click Install to Engine.
  5. An Install to Engine dialog box will appear; select the version(s) of Unreal Engine 4 to which you want to add the SkookumScript UE4 Plugin. Click Install.
  6. Get the SkookumDemo project and any other sample projects you want from our forum. Make sure to get the appropriate files for the UE4 version you are using.
  7. Extract the zip archive to My Documents\Unreal Projects. (If a different location is used for your project files, that’s fine.)
  8. For the Plugin to work properly, you must change some settings in the Unreal Editor. To launch the Unreal Editor, run the Epic Games Launcher, click the Unreal Engine tab, click Library, and then under My Projects, double-click SkookumDemo. Two windows will load: the SkookumIDE and the Unreal Editor.

    Depending on your system, the SkookumIDE and Unreal Editor may take a few minutes to load. If you receive a “SkookumScript UE4 Plugin cannot connect to the SkookumIDE!” message, wait a few seconds and click Try Again – the connection should be successful. This connection issue is usually caused by the Plugin attempting to connect to the SkookumIDE before the project has fully loaded.

    If your pesky firewall blocks the SkookumIDE, allow the SkookumIDE to communicate on the network(s) you are using.

  9. In the Unreal Editor, click the Edit tab, then click Editor Preferences…
  10. In the Editor Preferences… dialog box, click General, then click Miscellaneous, then click Performance, and ensure that Use Less CPU When In Background is unchecked. Click Set as Default (If you receive the “The default configuration file for these settings is not currently writable. Would you like to make it writable?” message, click Yes.)
  11. Also in the Editor Preferences… dialog box, click Level Editor, then click Miscellaneous, then click Sound, and ensure that Allow Background Audio is checked. Click Set as Default (If you receive the “The default configuration file for these settings is not currently writable. Would you like to make it writable?” message, click Yes.)

Have fun with your lovely new SkookumScript UE4 Plugin! Check out our Docs for more info, and if you have any questions, comments or suggestions, please share them on the SkookumScript Forum.

Update an existing install to the latest version

The UE4 Marketplace will alert you when an update of the SkookumScript UE4 Plugin is available. When that occurs, click on the SkookumScript badge and follow the instructions. Voilà!

Enjoy your updated SkookumScript UE4 Plugin! Check out our Docs for more info, and if you have any questions, comments or suggestions, please share them on the SkookumScript Forum.

Uninstall

  1. Run the Epic Games Launcher.
  2. Under the Unreal Engine tab, click Library.
  3. Under Engine Versions, click Installed Plugins under the relevant version of Unreal Engine.
  4. In the list of installed plugins, locate Skookumscript and click Remove.

Microsoft Visual Studio users

First-time install

We provide the SkookumScript Unreal Engine 4 Plugin source code via GitHub, so we can push updates and bug fixes to you frequently, and so you can send us pull requests with your own nifty additions and improvements. We assume you already have already used GitHub to get the Unreal Engine source code itself, so obtaining the SkookumScript Unreal Engine 4 Plugin source code should be straightforward.

Our plugin resides within the Engine/Plugins folder, so it is a GitHub repository within a GitHub repository. This is a supported configuration in Git, and Git handles it by automatically excluding anything in the subfolder from the parent repository. We recommend using Git from the command line for the initial cloning, as GUI tools such as SourceTree can get confused by this configuration. We assume your Unreal Engine version is 4.15.

  1. Open a command prompt.
  2. Ensure you have Git Large File Storage (Git LFS) enabled. (See extra info on installing Git LFS.)
  3. cd to your Engine/Plugins folder, and run this command:
    git clone https://github.com/AgogLabs/SkookumScript-UnrealEngine.git SkookumScript -b 4.15
  4. Get the SkookumDemo project and any other sample projects you want from our forum. Make sure to get the appropriate files for the UE4 version you are using.
  5. Extract the zip archive to My Documents\Unreal Projects. (If a different location is used for your project files, that’s fine.)
  6. Run GenerateProjectFiles.bat.
  7. Open the generated Visual Studio solution file.
  8. Right-click UnrealHeaderTool, then click Clean. (It is very important to do this before you build the engine or your project!)
  9. Build the engine or your project. As it builds, Module.SkookumScriptGenerator.cpp should fly past in the Output window to indicate that SkookumScriptGenerator has been properly recognized as a plugin.
  10. For the Plugin to work properly, you must change some settings in the Unreal Editor. To launch the Unreal Editor, run the Epic Games Launcher, click the Unreal Engine tab, click Library, and then under My Projects, double-click SkookumDemo or any other Unreal project. Two windows will load: the SkookumIDE and the Unreal Editor.

    Depending on your system, the SkookumIDE and Unreal Editor may take a few minutes to load. If you receive a “SkookumScript UE4 Plugin cannot connect to the SkookumIDE!” message, wait a few seconds and click Try Again – the connection should be successful. This connection issue is usually caused by the Plugin attempting to connect to the SkookumIDE before the project has fully loaded.

    If your pesky firewall blocks the SkookumIDE, allow the SkookumIDE to communicate on the network(s) you are using.

  11. In the Unreal Editor, click the Edit tab, then click Editor Preferences…
  12. In the Editor Preferences… dialog box, click General, then click Miscellaneous, then click Performance, and ensure that Use Less CPU When In Background is unchecked. Click Set as Default (If you receive the “The default configuration file for these settings is not currently writable. Would you like to make it writable?” message, click Yes.)
  13. Also in the Editor Preferences… dialog box, click Level Editor, then click Miscellaneous, then click Sound, and ensure that Allow Background Audio is checked. Click Set as Default (If you receive the “The default configuration file for these settings is not currently writable. Would you like to make it writable?” message, click Yes.)

The IDE will create a configuration .ini file for user settings on its first run if it does not already exist. Take a look for settings that aren’t exposed in the IDE user interface.

Have fun with your lovely new SkookumScript UE4 Plugin! Check out our Docs for more info, and if you have any questions, comments or suggestions, please share them on the SkookumScript Forum.

Update an existing install to the latest version

Important: If you want to preserve settings from your current install, save a copy of the file Engine/Plugins/SkookumIDE/SkookumIDE-user.ini in another location before updating, and restore it after updating.

  1. Open a command prompt, cd to your Engine/Plugins/SkookumScript folder and run git pull.
  2. Get the SkookumDemo project and any other sample projects you want from our forum. Make sure to get the appropriate files for the UE4 version you are using.
  3. Extract the zip archive to My Documents\Unreal Projects. (If a different location is used for your project files, that’s fine.)
  4. Run GenerateProjectFiles.bat
  5. Open the generated Visual Studio solution file.
  6. Right-click UnrealHeaderTool, then click Clean. (It is very important to do this before you build the engine or your project!)
  7. Build the engine or your project.
  8. Delete the SkookumScript folders in both your Engine/Content and SkookumDemo/Content folders.

Enjoy your updated SkookumScript UE4 Plugin! Check out our Docs for more info, and if you have any questions, comments or suggestions, please share them on the SkookumScript Forum.

Uninstall

  1. Delete the Engine/Plugins/SkookumScript folder.
  2. Build the engine or your project.