This page documents updates between various updates to SGDK 2.0. If you're interested in the differences between the 1.x versions and version 2.0, see the What's New section of the Introduction.

Version 2.1.6

This section describes updates between versions 2.1.5 and 2.1.6.

  1. Upgrade to Visual C# 2010 Express.
  2. Upgrade IDE to .NET 4.0 (projects should still work on 2.0).
  3. Updates for Windows 7 compatibility
    • Compile temp assembly is UserAppDataPath instead of %temp%.
    • Register file association to current user instead of system.
    • Turn off Windows 7 Aero when entering map editor to eliminate flickering when scrolling map editor.
  4. Eliminate unused System.Design.dll reference from generated game compiles.
  5. Implement support for ClickOnce deployment.
  6. Upgrade to latest SandCastle Help File Builder. Use MAML content to define help files instead of HTML.
  7. Limit Frame Rate to 30 FPS in sample project.
  8. Change ReturnToPreviousMap function to re-load map if unload = true and no previous map exists instead of ignoring the request.
  9. Change GetNearestSpriteIndex to ignore the current sprite.
  10. Correct distance calculation in PushTowardSprite.
  11. Change SetInputsTowardCategory to turn off all directional inputs if no sprite in target category exists.

Version 2.1.5

This section describes updates between versions 2.1.4 and 2.1.5.

  1. Fix sprite selector in map editor so other controls don't overlap it making some sprites unselectable.
  2. Correct tile drawing in map editor so it doesn't exhibit glitch after drawing plan paths.
  3. Prevent error when closing map editor when plan selection list is active.

Version 2.1.4

This section describes updates between versions 2.1.3 and 2.1.4.

  1. Fix an error that prevented multiple displays from being open simultaneously.
  2. Implement the ability to sort sprites in the map editor.
  3. Improve error handling when attempting to run the project if it is already running.
  4. Allow a layer to be created with a null tileset to represent the designer background layer (allow user-created layer to refer to no tileset).
  5. Stop riding on a platform if it is deactivated while riding it.
  6. Prevent debug-mode errors when a platform is deactivated and a sprite is riding on it.
  7. Change CheckNextCoordinate to proceed to the next target if the distance from the current target exactly matches the target distance.
  8. Prevent the user from creating a layer with zero tiles.
  9. Implement ExecuteRulesInternal so that ExecuteRules can be overridden in an intermediate class.
  10. Implement BaseClass property for plans and sprites to allow inheriting from customized code instead of only PlanBase and SpriteBase.
  11. Make ProcessSprites overridable.
  12. Implement IsSpriteWithinPolygon function for plans.
  13. When resetting source code to a template that imports decapsulated source code files, be sure to import the referenced code because the project into which the code is being imported will not know how to find the template's decapsulated files.
  14. Add OpenTK.dll.config to source control.
  15. If a plan contains a SpriteBase-derived member, show a drop-down list of the appropriate sprites in the map editor when this plan is selected.
  16. Prevent invalid sprite and plan names from being specified in the map editor.
  17. Change most SpriteBase and PlanBase members to be protected instead of private.
  18. Change most SpriteBase and PlanBase members to be virtual so they can be overridden by an intermediate base class.
  19. Change SpriteBase.TouchTiles to return a strongly typed collection of results.

Version 2.1.3

This section describes updates between versions 2.1.2 and 2.1.3.

  1. Upgrade to OpenTK 1.0.0 beta 2.
  2. Fix dropper tool to also function on row 0 and column 0 of graphic editor pane.
  3. Eliminate a couple compiler warnings on generated projects.
  4. Fix TestCollisionRect so that it can be used from the Plan and Sprite rule editors.
  5. Implement default designer-only background layer in map editor. When no opaque layer exists, the map editor will still draw nicely with this design-mode-only layer active.
  6. Automatically default new layers to next available Z-Index.
  7. Change Reflect.dll to build with .NET 2.0.
  8. Add SpriteRecorder code object to library for recording scripted sprite movements.
  9. Implement PlayMusic function that cross-fades background music.
  10. Implement FadeMusic function to fade out background music.
  11. Specify REUSE instead of FREE when playing FMOD sound to try to avoid sound scrambling occurring in some project(s).
  12. Improve FMOD code reuse - fmodbase.cs and fmod.cs are now delivered only in the Sound directory of the library, and all delivered templates refer to these files.
  13. Automatically sort main tree view.
  14. Correct bug that updated all children of a tile category in the tree view when the parent name was changed.
  15. Avoid error when pressing delete key on frameset editor when nothing has been selected.

Version 2.1.2

This section describes updates between versions 2.1 and 2.1.2.

  1. Upgrade to OpenTK 0.9.8.
  2. Check if graphic sheet (texture) is larger than supported by the OpenGL driver in order to provide a better error message if it's too big.
  3. Add TileCategoryTouched function to provide simpler ability to check when a sprite touches a tile in a category.
  4. Use frame's color modulation when drawing the frame with DrawCounterAsTile.
  5. Correct handling of TouchTiles for non-square sprites.
  6. Correct TileAddSprite to register old position as initial position.
  7. Create TileChangeTouched function to change one tile at a time.
  8. Deliver standard functions for pushing and repelling sprites.
  9. Improve error handling when converting rules to source code.
  10. Remove dllmap from configuration file because Microsoft .NET cannot handle it. Plan to use a hard link or symbolic link to new filename instead (linked to versioned
  11. Improve some sprite rule function implementations.
  12. Implement limited support for generating Linux projects.
  13. Prevent errors when null rule parameters are encountered while compiling.
  14. Improve drawing of gradient rings (2-D torus) in graphics editor.
  15. Upgrade FMOD to stable version 4.20.06.

Version 2.1

This section describes updates between versions 2.0 and 2.1.

  1. Upgrade to .NET 2.0: SGDK2 and the projects it generates now rely on .NET Framework version 2.0 and take advantage of new features added in this version. The SGDK2 Project itself requires Visual C# 2008 or .NET 3.0 to compile, but can run on any system that has .NET Framework 2.0. It also knows how to compile game projects on any system with .NET 2.0.
  2. OpenGL Framework: Version 2.0 was based on Managed DirectX. SGDK 2.1 uses the OpenTK library to access the OpenGL interface to video hardware, allowing SGDK2 to and the projects created with it to potentially be more easily ported to other platforms. This also provided an apparent performance boost.
  3. Improved Message Functions: Displaying messages is now an integrated function in SGDK2 instead of a custom object. Furthermore, it now uses a tileset as the font instead of using the fonst support provided by the system (because as of this writing, OpenTK does not properly support fonts). This means, however, that you can use graphics and animated tiles/characters in your messages. A new message preview window is provided to assist in laying out the message at design time.
  4. Frame Rate Limit: If your game runs too fast on some systems, you can now use the LimitFrameRate function to control the speed.
  5. Cut Rules: It's now possible to cut a group of rules when using a rule editor. This can also be used to delete hierarchies of rules.
  6. Upgrade Documentation: This help file is now being built with Sandcastle and Sandcastle Help File Builder instead of NDOC because NDOC did not support .NET 2.0. As a result the build process is somewhat simplified and the content is better linked with some other improvements wrapped in too.
  7. Convert Rules: In the sprite rule editor and plan rule editor, you may now select the "Convert to Function" command to convert rules into source code that can be directly maintained in the code editor. If you have huge trees of complex rules, this may help you significantly simplify your sprite definitions, and make them more managable.
  8. Call Sprite Functions from Plan Rules: Now you can select "<Select sprite function...>" from the function list in the plan rule editor if you want to directly call a function on a sprite from a plan. This can be particularly handy if you've converted a set of rules on a sprite into a function that you want a plan to be able to easily trigger directly.

If this list seems short, notice that the first two items are relatively large, and also that the goal was to get the major update out to folks and in use before proceeding with a multitude of smaller updates. That way everyone doesn't have to wait for all the small updates to be complete before being able to use the updated framework.