Difference between revisions of "The Ship SDK"

From Valve Developer Community
Jump to: navigation, search
(Availability)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Availability==
+
The Ship SDK, an extension of the [[SDK Installation|Source SDK]], includes custom map compilation tools, a modified version of VMEX, The Ship's FGD, and a tool called Deckplanner. The Ship SDK is available at [http://www.moddb.com/downloads/the-ship-sdk Mod DB]. To run the deckplan script generator, you must have [http://www.microsoft.com/en-us/download/details.aspx?id=17851 Microsoft .NET Framework Version 4.0] installed.
Included in [[The Ship]] SDK are map compilation tools, [[Vmex|VMEX]] (modified), The Ship's [[FGD]], and Deckplanner. Download the The Ship SDK [http://www.moddb.com/games/the-ship/downloads/the-ship-sdk here]. The Ship SDK utilizes the Source SDK, which is packaged along with Valve's Source games. Visit [http://store.steampowered.com/search/?category2=16 this page] to see a complete list of Source games that include the Source SDK. Purchase [{{valvestorefront game|appid=320}} Half-Life 2: Deathmatch] for only $4.99 to get full access to the Source SDK.
 
  
To run the deckplan script generator, you must have [http://www.microsoft.com/downloads/details.aspx?familyid=0856eacb-4362-4b0d-8edd-aab15c5e04f5&displaylang=en Microsoft .NET Framework Version 2.0] installed.
+
[http://www.moddb.com/downloads/the-ship-sdk http://button.moddb.com/download/medium/7337.png]
  
 
==News==
 
==News==
===Tuesday, January 15, 2007 SDK Update===
+
===Thursday, April 23, 2015 SDK Update===
* Fixed errors with running The Ship SDK with the Orange Box release of the Source SDK.{{note|The compiler crashes.}}
+
* Included SourceScheme.res in the package to address the [[Failed to load the default scheme file]] error.
 +
===Wednesday, August 27, 2014 SDK Update===
 +
* Bundled a more user-friendly version of the deckplanner tool with the SDK.
 +
===Sunday, January 19, 2014 SDK Update===
 +
* Resolved issues with using The Ship SDK with the latest Source SDK. Once installed, "The Ship" can be found under "Source SDK 2009" in the Source SDK launcher.
 +
* Ship tools are now based in folder ...\SourceSDK\bin\ship\bin
 +
===Monday, June 1th, 2009 SDK Update===
 +
* Folder structure modified to accommodate Source SDK folder structure changes
 +
===Sunday, May 20, 2007 SDK Update===
 +
* Ship tools are now based in folder ...\sourcesdk\ship
 +
* Official compilation tools are included
 +
===Tuesday, April 3, 2007 SDK Update===
 +
* Minor update to deckplan generator utility
 +
* Added Atalanta's deckplan source files to folder ...\sourcesdk_content\ship
 
===Saturday, March 31, 2007 SDK Update===
 
===Saturday, March 31, 2007 SDK Update===
 
* Adopted the official Outerlight FGD provided by [OL]Subs (Neil Davidson from Outerlight)
 
* Adopted the official Outerlight FGD provided by [OL]Subs (Neil Davidson from Outerlight)
* Added a tool called deckplanner which can be found in ..\sourcesdk\bin\deckplanner
+
* Added a tool called deckplanner which can be found in folder ...\sourcesdk\bin\deckplanner
 
** Algorithm provided by [OL]Subs
 
** Algorithm provided by [OL]Subs
 
* Added some sample deckplan files provided by [OL]Subs
 
* Added some sample deckplan files provided by [OL]Subs
===Tuesday, April 3, 2007 SDK Update===
+
===Tuesday, January 15, 2007 SDK Update===
* Minor update to deckplan generator utility
+
* Fixed errors with running The Ship SDK with the Orange Box release of the Source SDK.
* Added Atalanta's deckplan source files to ..\sourcesdk_content\ship
 
===Sunday, May 20, 2007 SDK Update===
 
* Ship tools are now based in ..\sourcesdk\ship
 
* Official compilation tools are included
 
===Monday, June 1th, 2009 SDK Update===
 
* Folder structure modified to accommodate Source SDK folder structure changes
 
  
 
==Installation==
 
==Installation==
#Replace all instances of <username> with your Steam username.
+
#Replace all instances of <SteamDir> in this document with your Steam directory (e.g. C:\Program Files (x86)\Steam).
#Copy all files in The_Ship_SDK.zip to your "..\Steam\SteamApps\<username>" folder.
+
#Extract all folders in The_Ship_SDK.zip to your "<SteamDir>\SteamApps\common" folder (if prompted to replace SourceScheme.res, you may be skip it).
#Open "..\Steam\SteamApps\<username>\sourcesdk\bin\GameConfig.txt" and add the following entry.{{note|If no GameConfig.txt exists, run the Source SDK once.}}
+
#Open "<SteamDir>\SteamApps\common\SourceSDK\bin\source2009\bin\GameConfig.txt" and add the following entry.{{note|If no such file exists, run the Source SDK once.}}
 
===Before===
 
===Before===
 
  }
 
  }
  "SDKVersion" "2"
+
  "SDKVersion" "4"
 
===Add===
 
===Add===
 
  "The Ship"
 
  "The Ship"
 
  {
 
  {
  "GameDir" "c:\program files\steam\steamapps\<username>\the ship\ship"
+
  "GameDir" "<SteamDir>\SteamApps\common\The Ship\ship"
 
  "hammer"
 
  "hammer"
 
  {
 
  {
  "GameData0" "c:\program files\steam\steamapps\<username>\sourcesdk\ship\TheShip.fgd"
+
  "GameData0" "<SteamDir>\SteamApps\common\SourceSDK\bin\source2009\bin\ship.fgd"
 
  "TextureFormat" "5"
 
  "TextureFormat" "5"
 
  "MapFormat" "4"
 
  "MapFormat" "4"
 
  "DefaultTextureScale" "0.250000"
 
  "DefaultTextureScale" "0.250000"
 
  "DefaultLightmapScale" "16"
 
  "DefaultLightmapScale" "16"
  "GameExe" "C:\Program Files\Steam\SteamApps\<username>\the ship\ship.exe"
+
  "GameExe" "<SteamDir>\SteamApps\common\The Ship\ship.exe"
 
  "DefaultSolidEntity" "func_detail"
 
  "DefaultSolidEntity" "func_detail"
 
  "DefaultPointEntity" "info_player_deathmatch"
 
  "DefaultPointEntity" "info_player_deathmatch"
  "BSP" "C:\Program Files\Steam\SteamApps\<username>\sourcesdk\ship\vbsp.exe"
+
  "BSP" "<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vbsp.exe"
  "Vis" "C:\Program Files\Steam\SteamApps\<username>\sourcesdk\ship\vvis.exe"
+
  "Vis" "<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vvis.exe"
  "Light" "C:\Program Files\Steam\SteamApps\<username>\sourcesdk\ship\vrad.exe"
+
  "Light" "<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vrad.exe"
  "GameExeDir" "C:\program files\steam\steamapps\<username>\the ship"
+
  "GameExeDir" "<SteamDir>\SteamApps\common\The Ship"
  "MapDir" "c:\program files\steam\steamapps\<username>\sourcesdk_content\ship\mapsrc"
+
  "MapDir" "<SteamDir>\SteamApps\common\sourcesdk_content\ship\mapsrc"
  "BSPDir" "C:\Program Files\Steam\SteamApps\<username>\the ship\ship\maps"
+
  "BSPDir" "<SteamDir>\SteamApps\common\The Ship\ship\maps"
 
  "CordonTexture" "tools\toolsskybox"
 
  "CordonTexture" "tools\toolsskybox"
 
  "MaterialExcludeCount" "0"
 
  "MaterialExcludeCount" "0"
Line 54: Line 60:
  
 
==Usage==
 
==Usage==
* You must run "..\Steam\SteamApps\<username>\sourcesdk\ship\launchsdk.bat" to launch the SDK once after each time of launching The Ship. You may run the batch file with a shortcut if you are so inclined.}}
+
* Launch Source SDK from Steam. Select "Source Engine 2009" for Engine Version. Select "The Ship" for Current Game.
* It is recommended that you first decompile a few maps in "..\Steam\SteamApps\the ship common.gcf" so you get a sense of how to construct the map's gameplay & functionality. See [[GCFScape]] for [[BSP]] extraction.
+
* It is recommended that you first decompile a few maps in "<SteamDir>\SteamApps\common\The Ship\vpks\depot_2402_dir.vpk" to get a sense of how to construct the map's gameplay & functionality. [[GCFScape]] is a handy tool for extracting the [[BSP]] files which are found within the folder ship/maps in the [[VPK]].
* You may run into an issue where The Ship never appears on the Source SDK configuration list. To fix this, you should open your modified GameConfig.txt in notepad before launching the SDK, resave it if it doesn't appear in the list, and switch to a different configuration to reload the GameConfig.txt file.
+
* All tools are located in folder ...\SourceSDK\bin\ship\bin
* All tools are located in ..\sourcesdk\ship
+
* See [[The Ship: Creating a Deckplan]] for the steps to putting together a deckplan for your maps.
  
 
==See Also==
 
==See Also==

Latest revision as of 04:21, 24 April 2015

The Ship SDK, an extension of the Source SDK, includes custom map compilation tools, a modified version of VMEX, The Ship's FGD, and a tool called Deckplanner. The Ship SDK is available at Mod DB. To run the deckplan script generator, you must have Microsoft .NET Framework Version 4.0 installed.

7337.png

News

Thursday, April 23, 2015 SDK Update

Wednesday, August 27, 2014 SDK Update

  • Bundled a more user-friendly version of the deckplanner tool with the SDK.

Sunday, January 19, 2014 SDK Update

  • Resolved issues with using The Ship SDK with the latest Source SDK. Once installed, "The Ship" can be found under "Source SDK 2009" in the Source SDK launcher.
  • Ship tools are now based in folder ...\SourceSDK\bin\ship\bin

Monday, June 1th, 2009 SDK Update

  • Folder structure modified to accommodate Source SDK folder structure changes

Sunday, May 20, 2007 SDK Update

  • Ship tools are now based in folder ...\sourcesdk\ship
  • Official compilation tools are included

Tuesday, April 3, 2007 SDK Update

  • Minor update to deckplan generator utility
  • Added Atalanta's deckplan source files to folder ...\sourcesdk_content\ship

Saturday, March 31, 2007 SDK Update

  • Adopted the official Outerlight FGD provided by [OL]Subs (Neil Davidson from Outerlight)
  • Added a tool called deckplanner which can be found in folder ...\sourcesdk\bin\deckplanner
    • Algorithm provided by [OL]Subs
  • Added some sample deckplan files provided by [OL]Subs

Tuesday, January 15, 2007 SDK Update

  • Fixed errors with running The Ship SDK with the Orange Box release of the Source SDK.

Installation

  1. Replace all instances of <SteamDir> in this document with your Steam directory (e.g. C:\Program Files (x86)\Steam).
  2. Extract all folders in The_Ship_SDK.zip to your "<SteamDir>\SteamApps\common" folder (if prompted to replace SourceScheme.res, you may be skip it).
  3. Open "<SteamDir>\SteamApps\common\SourceSDK\bin\source2009\bin\GameConfig.txt" and add the following entry.
    Note:If no such file exists, run the Source SDK once.

Before

	}
	"SDKVersion"		"4"

Add

		"The Ship"
		{
			"GameDir"		"<SteamDir>\SteamApps\common\The Ship\ship"
			"hammer"
			{
				"GameData0"		"<SteamDir>\SteamApps\common\SourceSDK\bin\source2009\bin\ship.fgd"
				"TextureFormat"		"5"
				"MapFormat"		"4"
				"DefaultTextureScale"		"0.250000"
				"DefaultLightmapScale"		"16"
				"GameExe"		"<SteamDir>\SteamApps\common\The Ship\ship.exe"
				"DefaultSolidEntity"		"func_detail"
				"DefaultPointEntity"		"info_player_deathmatch"
				"BSP"		"<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vbsp.exe"
				"Vis"		"<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vvis.exe"
				"Light"		"<SteamDir>\SteamApps\common\SourceSDK\bin\ship\bin\vrad.exe"
				"GameExeDir"		"<SteamDir>\SteamApps\common\The Ship"
				"MapDir"		"<SteamDir>\SteamApps\common\sourcesdk_content\ship\mapsrc"
				"BSPDir"		"<SteamDir>\SteamApps\common\The Ship\ship\maps"
				"CordonTexture"		"tools\toolsskybox"
				"MaterialExcludeCount"		"0"
			}
		}

Usage

  • Launch Source SDK from Steam. Select "Source Engine 2009" for Engine Version. Select "The Ship" for Current Game.
  • It is recommended that you first decompile a few maps in "<SteamDir>\SteamApps\common\The Ship\vpks\depot_2402_dir.vpk" to get a sense of how to construct the map's gameplay & functionality. GCFScape is a handy tool for extracting the BSP files which are found within the folder ship/maps in the VPK.
  • All tools are located in folder ...\SourceSDK\bin\ship\bin
  • See The Ship: Creating a Deckplan for the steps to putting together a deckplan for your maps.

See Also