Scaleform source access

We’re excited to let you know that Scaleform source code is now available on GitHub.

To access the Scaleform repository, you’ll need to link your Gamedev and Github accounts.

• If you don’t have a GitHub user account, sign up here: http://www.github.com.
• In the Gamedev portal, provide your GitHub account. To do so, click your name and select Profile, then enter your GitHub account name in the GitHub Username field, and click Save.
• Request Scaleform source access in our public GitHub, https://github.com/AutodeskGames/. Email gamedev@autodesk.com to request access to the Scaleform source.

Once granted access, visit the Scaleform repo, https://github.com/AutodeskGames/scaleform-gfx. Install the software requirements as outlined in the README.md, clone the scaleform-gfx repo and create an environment variable SF_LIB_DIR to store the libraries required to build Scaleform.

Run make.rb script in the root directory of the Scaleform source code repository. The make.rb script will automatically get all the libraries it needs to build all of the targets you ask it to build. It will also generate and build projects for the Scaleform engine, tools and samples, and place them in the Bin directory in your cloned Scaleform directory.

The Scaleform repository is set up with the following branches:

• master: This is a tested, QA-approved branch. It typically corresponds to a milestone release of the publicly released binary installer packages. It receives periodic, controlled updates that roll up all changes made in the release branch since the last update.
• develop: This branch is a live mirror of the internal development branch used internally within Autodesk. This branch receives very frequent and potentially disruptive commits. Therefore, it is generally recommended that you work from the master branch unless you need a particular feature or fix that has been introduced since the last update to the master branch.
• release/4.6.34: This branch contains the bug fixes and features for the public release of 4.6.34.

If you are a registered developer for one or more "closed" console platforms, you will see these additional repositories under the Autodesk Games team:

• scaleform-gfx-ps4: This repo is for building Scaleform with PlayStation 4 console support and is distributed to licensed PlayStation developers.
• scaleform-gfx-xb1: This repo is for building Scaleform with the Xbox One console support and is distributed to licensed Xbox developers.
• scaleform-gfx-switch: This repo is for building Scaleform with the Nintendo Switch and is distributed to licensed Nintendo Switch developers.

These child repositories are submodules of the main scaleform-gfx repository, and located in the Platforms directory. To access them, initialize each submodule and update them. From a command prompt in your Scaleform repository, run the following commands (only the lines corresponding to the repos you have access to):

> git submodule init Platforms/ps4
> git submodule init Platforms/xb1
> git submodule init Platforms/switch
> git submodule update

This copies the submodule's repository locally to your computer, so that you can build the engine for that platform. You should now see some new files inside the Platform folders.

When you clone or update your Scaleform repository, your git client may report errors about updating submodules, or about being unable to access the https://github.com/AutodeskGames/ repository. As long as these errors refer to submodule repositories for platforms that you don't have access to, you can safely ignore these errors. They won't prevent you from getting any code that you need.

To avoid seeing these errors in future:

• Configure your Git client to not clone or update recursively. This means that when you clone or update the main scaleform-gfx repository, your git client won't try to clone or update the missing repositories.

• If you need to update submodules, update only the one you need instead of updating all submodules in the main repository.

  For example, instead of running git submodule update, which updates all submodules in the repository, use git submodule update Platforms/ps4, git submodule update Platforms/xb1, and git submodule update Platforms/switch.