Difference between revisions of "Steam 3rd Party Mod Support"

From Valve Developer Community
Jump to: navigation, search
(Source)
 
(54 intermediate revisions by 15 users not shown)
Line 1: Line 1:
=Getting the most out of Steam for your Mod=
+
{{otherlang2|ru=Steam_3rd_Party_Mod_Support:ru|jp=Steam_3rd_Party_Mod_Support:jp}}
There are a two things you should do to make your Mod more visible in Steam.
 
  
==Store Tab==
+
== Store tab ==
Get your Mod listed under the "Store" tab. To do this add an entry to   [[:Category:HL2_Third_Party_Mods]] or [[:Category:HL1_Third_Party_Mods]] using these guidelines:
+
Get your Mod listed under the "Store" tab. To do this add an entry to [[:Category:Source mods]] or [[:Category:GoldSrc mods]] using these guidelines:
:1. Have a short 50 words or less description of the game.
+
#Have a short description of the game.
:2. Include 5 screenshots in .jpg format. The width of the screenshots can be no greater that 1024px, but the aspect ratio is up to you.
+
#Include 5-10 screenshots in JPG format. Ideally in widescreen format such as 1920x1080 or 1280x720.
 +
#Provide a game page header image of 460x215 (should include your logo and key art. Please look around the Steam store for examples) [http://storefront.steampowered.com/v/mods/mod_headerTemplate.psd Photoshop Template]
 +
#Provide a small game capsule of 231x87 (should include your logo and key art. This image shows up in search results and other lists throughout Steam) [http://storefront.steampowered.com/v/mods/mod_smCapsuleTemplate.psd Photoshop Template]
  
If your Mod becomes one of the top Mod's being played then you will appear in the store using the information you supplied in the above post.
+
{{tip|Use [http://gimp.org/ The GIMP] to edit Photoshop files for free.}}
  
 +
If your Mod becomes one of the top Mods being played then you will appear in the store using the information you supplied in the above post.
  
==Developer Link==
+
== My Games list ==
 
Setup a developer link in the "My Games" page when a user installs your Mod.  
 
Setup a developer link in the "My Games" page when a user installs your Mod.  
  
===[[Source]]===
+
=== Source ===
Use the following keyvalues in your ''gameinfo.txt'' file. For example:
+
You can use the following keyvalues in your [[The GameInfo.txt File Structure|GameInfo.txt]] file.
 +
developer "Mod Team/Company Name"
 +
developer_url "<nowiki>http://...</nowiki>"
 +
icon "path/to/icon"
 +
manual "<nowiki>http://...</nowiki>"
  
"developer" "Mod Team/Company Name"
+
The icon must be an uncompressed, 24-bit format [[TGA]], 16x16 pixels in size. The path is relative to the mod's installation directory (i.e where [[The GameInfo.txt File Structure|GameInfo.txt]] is) and should not include the TGA file extensionIn the example above, the file would be "path/to/icon.tga" inside the mod directory.
"developer_url" "<nowiki>http://...</nowiki>"
 
  "icon" "path/to/icon"  
 
  
The icon must be an uncompressed TGA 16x16 pixels in size. The path is relative to the mods installation directory (i.e where Gameinfo.txt is) and should not include the '.tga' file extension.
+
Mod makers should also include a 32x32 pixel version of their mod icon. This should be in the same directory and have the same filename as the standard 16x16 icon but with "_big" appended. In the above example, the big icon would have the filename "path/to/icon_big.tga" This is used in the details view of the Steam library window. If a big icon isn't included, Steam will fall back to the 16x16 icon.
  
===[[Goldsource]]===
+
=== Goldsource ===
Use the following keyvalues in your ''liblist.gam''. Steam will also fall back to use a "url_info" line if it exists. For example:
+
You can use the following keyvalues in your ''liblist.gam''.
 +
developer "Mod Team/Company Name"
 +
developer_url "<nowiki>http://...</nowiki>"
 +
icon "path/to/icon"
 +
manual "<nowiki>http://...</nowiki>"
  
  developer "Mod Team/Company Name"
+
The icon must be an uncompressed, 24-bit format [[TGA]], 16x16 pixels in size. The path is relative to the mod's installation directory (i.e where [[liblist.gam]] is) and should not include the TGA file extension. In the example above, the file would be "path/to/icon.tga" inside the mod directory.
developer_url "<nowiki>http://...</nowiki>"
 
  
 +
== Desktop icon ==
 +
Creating a desktop icon for your mod is simple. Just place an icon file in the <code>&lt;Steam&gt;\steam\games</code> with the same name as the <code>Game</code> keyvalue specified in your [[The GameInfo.txt File Structure|GameInfo.txt]]/[[The liblist.gam File Structure|liblist.gam]] file.  Remember to omit all colons from the icon's filename and the filename is case insensitive.
  
[[Category:Steam]]
+
To install the icon there, use <code>HKEY_LOCAL_MACHINE\Software\Valve\Steam\InstallPath</code> from the registry and append <code>\steam\games</code> to it.
[[Category:Tutorials]]
+
 
 +
== See also ==
 +
* [[The GameInfo.txt File Structure]]
 +
* [[Source Mod Installers]]
 +
* [[TGA]]
 +
 
 +
[[Category:Steam]][[Category:Tutorials]]
 +
__NOTOC__

Latest revision as of 20:40, 25 October 2011

Русский 日本語

Store tab

Get your Mod listed under the "Store" tab. To do this add an entry to Category:Source mods or Category:GoldSrc mods using these guidelines:

  1. Have a short description of the game.
  2. Include 5-10 screenshots in JPG format. Ideally in widescreen format such as 1920x1080 or 1280x720.
  3. Provide a game page header image of 460x215 (should include your logo and key art. Please look around the Steam store for examples) Photoshop Template
  4. Provide a small game capsule of 231x87 (should include your logo and key art. This image shows up in search results and other lists throughout Steam) Photoshop Template
Tip:Use The GIMP to edit Photoshop files for free.

If your Mod becomes one of the top Mods being played then you will appear in the store using the information you supplied in the above post.

My Games list

Setup a developer link in the "My Games" page when a user installs your Mod.

Source

You can use the following keyvalues in your GameInfo.txt file.

developer	"Mod Team/Company Name"
developer_url	"http://..."
icon		"path/to/icon"
manual		"http://..."

The icon must be an uncompressed, 24-bit format TGA, 16x16 pixels in size. The path is relative to the mod's installation directory (i.e where GameInfo.txt is) and should not include the TGA file extension. In the example above, the file would be "path/to/icon.tga" inside the mod directory.

Mod makers should also include a 32x32 pixel version of their mod icon. This should be in the same directory and have the same filename as the standard 16x16 icon but with "_big" appended. In the above example, the big icon would have the filename "path/to/icon_big.tga" This is used in the details view of the Steam library window. If a big icon isn't included, Steam will fall back to the 16x16 icon.

Goldsource

You can use the following keyvalues in your liblist.gam.

developer	"Mod Team/Company Name"
developer_url	"http://..."
icon		"path/to/icon"
manual		"http://..."

The icon must be an uncompressed, 24-bit format TGA, 16x16 pixels in size. The path is relative to the mod's installation directory (i.e where liblist.gam is) and should not include the TGA file extension. In the example above, the file would be "path/to/icon.tga" inside the mod directory.

Desktop icon

Creating a desktop icon for your mod is simple. Just place an icon file in the <Steam>\steam\games with the same name as the Game keyvalue specified in your GameInfo.txt/liblist.gam file. Remember to omit all colons from the icon's filename and the filename is case insensitive.

To install the icon there, use HKEY_LOCAL_MACHINE\Software\Valve\Steam\InstallPath from the registry and append \steam\games to it.

See also