SoftwareDevelopmentKit

LANDIS-II SDK

The purpose of the LANDIS-II Software Development Kit (SDK) is to provide a convenient collection of resources useful to developers who are writing and distributing L-II extensions.

Currently, it contains tools, scripts and files for:

• Staging (copying) assemblies into the protected Windows folder where LANDIS-II is installed (C:\Program Files\);
• Building Windows installers (setup programs) for L-II extensions; and
• Creating NuGet packages for L-II libraries.

Version Numbering

The SDK version corresponds to a particular major version series of LANDIS-II. For example, SDK v6 contains resources for developers targeting the version 6.X series of LANDIS-II.

Installation

• Create a folder for the SDK; for example:

    C:\Users\You\projects\LANDIS-II\SDK
  

• Get the zip file for the desired release listed below.

• Unpack the zip file into its own subfolder of the SDK folder. For example, if you've downloaded release 02 of SDK v6, then unpack its contents into this subfolder:

    C:\Users\You\projects\LANDIS-II\SDK\v6-r02
  

• Set the LANDIS_SDK environment to the particular release you want to use; for example,

    LANDIS_SDK=%USERPROFILE%\projects\LANDIS-II\SDK\v6-r02
  

Revision History

SDK v6 - Release 06 -- 18 December 2014

• Fixed a couple bugs in the staging scripts:
  • The scripts could not handle a space in an assembly's file name (e.g., "Foo Bar.dll").
  • If a file to be staged did not exist in the LANDIS-II build directory, then the script would incorrectly prompt for user input. This would make IDEs (e.g., Visual Studio) appear to hang while running a project's post-build command.
• The version numbering scheme has been simplified to avoid any confusion between minor versions of the SDK and LANDIS-II. A new minor version of LANDIS-II v6 does not require a new minor version of SDK v6. To eliminate any ambiguity, the SDK now has just a major version number that matches the major version series of LANDIS-II that the SDK targets.

SDK 6.0 - Release 05 -- 30 November 2014

• The staging scripts added in release 04 have been enhanced to support the staging (copying) of multiple files when a project is compiled. For example, in addition to a project's assembly, its symbol (.pdb) and documentation (.xml) files can also be copied. See the release's README.txt file for details.
• The SDK includes the NuGet command line tool (v 2.8.3) for creating NuGet packages for libraries.

SDK 6.0 - Release 04 -- 9 August 2014

• Added scripts to allow a developer to stage (copy) a project's assembly into the LANDIS-II directory structure with Window's UAC enabled. See the release's README.txt file for details.
  • Starting with this release, the naming convention for the release's zip file has changed. A hyphen is now used instead of a comma to separate the version and release numbers. This change was required because Windows Task Scheduler doesn't support commas in file paths.

SDK 6.0, Release 03 -- 5 March 2013

• Fixed bug in Inno Setup script that reads an extension's info file.
  • When no release info is in the info file, the release type defaults to "official". However, this default value was not set with the proper visibility, so it wasn't seen by other Inno Setup files.

SDK 6.0, Release 02 -- 13 February 2013

• Major refactoring to address limitations in the Inno Setup scripts
• Developers can now specify their organizations as the publisher of their extensions.
• Developers can now specify the license that they've selected for their extensions.
• An extension's info file is now loaded by Inno Setup to ensure that the extension's Window installer is consistent with the settings in the info file.
• Updated for the revised directory structure of L-II 6.0 rc3.

SDK 6.0, Release 01 -- 18 January 2013

• Contains the minimal set of files necessary for Inno Setup to compile scripts written for LANDIS-II 6.0 release candidate 2 (rc2) and earlier releases.