The Ship SDK: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Updated the installation page so that it is easier to follow along, also so that the design matches that of the other installation pages, moved the news section to its own page)
Line 1: Line 1:
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.
{{back | The Ship Level Creation}}
{{DISPLAYTITLE: The Ship SDK Installation}}
{{toc-right}}


[http://www.moddb.com/downloads/the-ship-sdk http://button.moddb.com/download/medium/7337.png]
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 custom tool called ''Deckplanner'' used to create decks for your maps. The tools is created to be used by the Source SDK Developer Tools rather than being a stand alone development kit, as such make sure that you have it installed beforehand.


==News==
{{clr}}
===Thursday, April 23, 2015 SDK Update===
* 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===
* 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==
== Download ==
#Replace all instances of <SteamDir> in this document with your Steam directory (e.g. C:\Program Files (x86)\Steam).
The official The Ship development tools are not available via Steam, instead start off by downloading them from [http://www.moddb.com/downloads/the-ship-sdk ModDB] and extract the content using something like [http://www.7-zip.org/ 7-Zip] to somewhere on your computer like your desktop.  
#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 "<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==
If you plan on using the deckplan script generator, you should also make sure you have the [http://www.microsoft.com/en-us/download/details.aspx?id=17851 Microsoft .NET Framework Version 4.0].
* 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==
== Installation ==
* [[:Category:The Ship]]
Before the installation process can begin, make sure you have run the Source SDK and hammer at least once. Then copy all the folders inside of the newly extracted folder  (SourceSDK,sourcesdk_content,The Ship) to the directory where your steam library is located (example ''C:\Program Files\Steam\steamapps\common\''), althrough you may skip ''SourceScheme.res'' if you are prompted to replace it.
* [[The Ship Single Player: Starting your Mod]]


[[Category:Third Party Tools]]
Next you will have to tell Hammer where to look for these files you have just pasted. To do this, open the ''GameConfig.txt'' file located in the ''\bin\source2009\bin\'' folder inside of the Source SDK directory and add the following entry to the ''"Games"'' block. You also have to correct all instances of the ''$SteamUserDir'' strings, to the directory where your steam library is located on your computer:
 
<pre>
"The Ship"
{
"GameDir"         "$SteamUserDir\The Ship\ship"
"hammer"
{
"GameData0" "$SteamUserDir\SourceSDK\bin\source2009\bin\ship.fgd"
"TextureFormat" "5"
"MapFormat" "4"
"DefaultTextureScale" "0.250000"
"DefaultLightmapScale" "16"
"GameExe" "$SteamUserDir\The Ship\ship.exe"
"DefaultSolidEntity" "func_detail"
"DefaultPointEntity" "info_player_deathmatch"
"BSP"         "$SteamUserDir\SourceSDK\bin\ship\bin\vbsp.exe"
"Vis"         "$SteamUserDir\SourceSDK\bin\ship\bin\vvis.exe"
"Light"         "$SteamUserDir\SourceSDK\bin\ship\bin\vrad.exe"
"GameExeDir" "$SteamUserDir\The Ship"
"MapDir" "$SteamUserDir\sourcesdk_content\ship\mapsrc"
"BSPDir" "$SteamUserDir\The Ship\ship\maps"
"CordonTexture" "tools\toolsskybox"
"MaterialExcludeCount" "0"
}
}
</pre>
 
== Accessing The Ship SDK ==
To use to the map development tools, simply launch the Source SDK from your Steam library like any other game, then select "Source Engine 2009" for Engine Version and "The Ship" for Current Game. From here you should be able to create new maps by using the [[Hammer Editor]] and using the [[Prefab | prefabs]] that are a part of the sdk installation to easier make your first level.
 
It is furthermore recommended that you decompile the official maps located in ''\The Ship\vpks\depot_2402_dir.vpk'' to get a sense of how to construct the map's gameplay and functionality. [[GCFScape]] is a handy tool for extracting the [[BSP]] map files which are found within the folder ''ship/maps'' in the [[VPK]] package. If you want to create deck plans, please see [[The Ship: Creating a Deckplan | How to create a Deckplan]] for the steps to putting together a deckplan for your maps.
 
== Package includes ==
The package includes:
* The Ship [[FGD]] file.
* 28 premade frabrications for Hammer.
* Suite of Hammer map command line compiling utilities.
* The deckplan script generator, used to create deck plans.
* Resources required to get the tools running with Source SDK.
 
== Where do I go from here? ==
* The [[The Ship Level Creation]] is a good place to go if you are familiar with Source mapping already. If not, you will need to master the basics of Source level design first ([[:Category:Level Design|Level Design]]).
* If you want to learn about how to create content for the Source Engine in general, the main page of the [[SDK Docs | Source SDK documentation]] is a good place to start.
 
== Bugs and issues ==
* Post all issues and bugs in the [https://steamcommunity.com/app/2400/discussions/ Dark Messiah Steam Discussions Board].
* If you have a bug specific to the The Ship SDK or game and perhaps know a fix, please add it as an entry to [[The Ship Bugs]].
* See the [[:Category:Source SDK FAQ | Source SDK FAQ]] for answers to general SDK questions.
* For level design and Hammer editor issues, see the [[:Category:Level Design FAQ | Level Design FAQ]].
 
[[Category:Level Design]][[Category:The Ship]]

Revision as of 18:07, 17 January 2022

The Ship Level Creation

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 custom tool called Deckplanner used to create decks for your maps. The tools is created to be used by the Source SDK Developer Tools rather than being a stand alone development kit, as such make sure that you have it installed beforehand.

Download

The official The Ship development tools are not available via Steam, instead start off by downloading them from ModDB and extract the content using something like 7-Zip to somewhere on your computer like your desktop.

If you plan on using the deckplan script generator, you should also make sure you have the Microsoft .NET Framework Version 4.0.

Installation

Before the installation process can begin, make sure you have run the Source SDK and hammer at least once. Then copy all the folders inside of the newly extracted folder (SourceSDK,sourcesdk_content,The Ship) to the directory where your steam library is located (example C:\Program Files\Steam\steamapps\common\), althrough you may skip SourceScheme.res if you are prompted to replace it.

Next you will have to tell Hammer where to look for these files you have just pasted. To do this, open the GameConfig.txt file located in the \bin\source2009\bin\ folder inside of the Source SDK directory and add the following entry to the "Games" block. You also have to correct all instances of the $SteamUserDir strings, to the directory where your steam library is located on your computer:

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

Accessing The Ship SDK

To use to the map development tools, simply launch the Source SDK from your Steam library like any other game, then select "Source Engine 2009" for Engine Version and "The Ship" for Current Game. From here you should be able to create new maps by using the Hammer Editor and using the prefabs that are a part of the sdk installation to easier make your first level.

It is furthermore recommended that you decompile the official maps located in \The Ship\vpks\depot_2402_dir.vpk to get a sense of how to construct the map's gameplay and functionality. GCFScape is a handy tool for extracting the BSP map files which are found within the folder ship/maps in the VPK package. If you want to create deck plans, please see How to create a Deckplan for the steps to putting together a deckplan for your maps.

Package includes

The package includes:

  • The Ship FGD file.
  • 28 premade frabrications for Hammer.
  • Suite of Hammer map command line compiling utilities.
  • The deckplan script generator, used to create deck plans.
  • Resources required to get the tools running with Source SDK.

Where do I go from here?

  • The The Ship Level Creation is a good place to go if you are familiar with Source mapping already. If not, you will need to master the basics of Source level design first (Level Design).
  • If you want to learn about how to create content for the Source Engine in general, the main page of the Source SDK documentation is a good place to start.

Bugs and issues