Skip to content

Installing and Building ATF

Jump to bottom
gstaas edited this page Oct 29, 2014 · 3 revisions

This topic helps you install and build ATF.

Table of Contents

Downloading ATF

You can download ATF several ways.

GitHub

ATF is an open source project on GitHub. The ATF GitHub repository contains the latest public release. You can either clone the project to your desktop or download a ZIP file from this ATF GitHub page.

ZIP File

For Sony employees who are members of SCE with SHIP accounts, current and past ATF versions are available as ZIP files.

Package Manager

For Sony employees who are members of SCE with SHIP accounts, the Package Manager is a good way to get updates, because it can update multiple components of the WWS SDK together, taking into account dependencies.

  1. Download the Package Manager.
  2. Place the wwspm.exe file at the root of your WWS SDK folder.
  3. Run the following command from your WWS SDK root folder in a Windows Command Prompt:
>wwspm install wws_atf

Or, if you are updating an existing installation:

>wwspm update wws_atf

You are then asked if you want to create a new or update an existing ATF installation. Enter "y" and Return. Package Manager finds the ATF component and asks if you want to proceed to install it. Enter "y" and Return to install ATF. The version number of ATF displays as it is installed.

ATF Folder Contents

Regardless of how you obtain ATF, its release package contains the following folders:

  • DevTools: Tools to help our clients set-up, port, and manage their ATF projects. For example, if you are using the ATF DOM, DomGen generates a schema class from an XML schema file that you can use in your application. For more about DomGen, see the ATF Programmer’s Guide: Document Object Model (DOM) that you can download at ATF Documentation.
  • Docs: ATF Documentation including programmer and reference documentation. This does not include the wiki-based documentation.
  • Framework: ATF C# source, in folders corresponding to Visual Studio projects. Clients should be very careful about modifying this code to avoid breaking functionality.
  • Samples: Code for sample applications that demonstrate various aspects of ATF and its features. It includes all .sln and .csproj files and full source. For details on all the samples, see ATF Code Samples. Clients are encouraged to start with a sample application and then modify it, as described in Creating an Application from an ATF Sample.
  • Test: Unit tests and Everything.sln, which is our solution file that references all source code in the ATF distribution.
  • ThirdParty: Pre-compiled managed and unmanaged DLLs and information for third party software that is licensed to be used by ATF.

Building ATF

The ATF source is organized into a set of Visual Studio solution and project files. The main solution files are:

  • \Samples\Samples.sln: includes all of the ATF 3 samples and framework. To try the ATF sample applications, open and build this solution.
  • \Test\Everything.sln: includes ATF 3 and ATF 2 framework and samples, unit tests, functional tests, and development tools. (ATF 2 is not on GitHub.) To build all the samples, development tools, and unit tests, open and build this solution.
Both solutions build ATF and all the samples. The sample applications' executables are placed in the \bin folder.

Project Warnings

Although we don't ship ATF with any C# compiler warnings, there are some project warnings that you may see when you open a few ATF projects in Visual Studio. These are unlikely to cause problems, but here is an explanation for what is happening.

Atf.Core

This project has a warning about a possible run-time error due to a mismatch between the processor architecture with Wws.LiveConnect.dll. This is a false warning, because this DLL is not actually copied to the output directory. (The copy local setting is set to false.) The application's project, like TimelineEditor, has to reference the correct version of Wws.LiveConnect.dll (x86 or x64). These sample applications provide an example of how to conditionally reference the correct DLL based on the target processor architecture. For a future release of ATF, a new Wws.LiveConnect.dll should be available that targets AnyCPU, and so this warning will go away.

Atf.Gui.OpenGL

This project has a warning about a possible run-time error due to a mismatch between the processor architecture with DDSUtils.dll. There has been a very long-standing requirement that to use this NVidia utility (as for opening certain image files), you have to target the x86 processor architecture. New clients within Sony should use the Direct3D native C++ rendering of the new LevelEditor component in the WWS SDK.

Atf.Perforce

This project has a warning about not being able to link to the file p4bridge.dll. This is not a valid warning, because there are two conditional links to p4bridge.dll, but both links can't be active at the same time. One conditional link is for 32-bit compiling and the other is for 64-bit.

About

Learning

© 2014-2015, Sony Computer Entertainment America LLC
Clone this wiki locally