Resource list (Source): Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(19 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{LanguageBar}}
{{tabs|Resource list|goldsrc=true|source=true}}
A '''Resource list''' (<code>.res</code> file) accompanies a map. When the map is running, it directs the server to push arbitrary files to connecting clients.
A '''Resource list''' (<code>.res</code> file) accompanies a map. When the map is running, it directs the server to push arbitrary files to connecting clients.


While it is generally preferable to achieve this by using [[BSPZIP]] to embed the files into the map itself, there are occasional situations where only loose files and a .res will work.
While it is generally preferable to achieve this by using [[BSPZIP]] to embed the files into the map itself, there are occasional situations where only loose files and a .res will work.


{{note|A resource list must be located in the <code>\maps</code> folder with the same name as the associated BSP.}}
{{warning|Clients can choose to not loose sound files, or not download any files except the BSP itself! Prefer using [[BSPZIP]] or similar to pack custom content into the map when possible.}}


== Example ==
== Example ==
Line 9: Line 11:
  Resources
  Resources
  {  
  {  
  materials/vdc/some_material.vmt file
  "materials/vdc/some_material.vmt" "file"
  materials/vdc/some_material.vtf file
  "materials/vdc/some_material.vtf" "file"
  }
  }


Remember to enclose any paths containing spaces with "quote marks" (e.g. <code>"materials/oh look some spaces/material.vtf" file</code>).
{{tip|.txt, .res, .ain, and .nav files with the same name as the map are automatically pushed, and don't need to be included.}}
{{tip|If a .mdl file is listed, .vvd, .ani, .dx80.vtx, .dx90.vtx, .sw.vtx, .phy, and .jpg files with the same name and path as the .mdl will also automatically be pushed.}}
{{todo|What data types are there beside <code>file</code>? It seems to not matter what type is specified, as long as the type definition isn't empty or absent.}}
{{todo|Can a .res be safely [[BSPZIP]]ped?}}


{{tip|.txt, .res, .ain and .nav files with the same name as the map are automatically pushed, and don't need to be included.}}
== Files ==
A resource list must be located in the {{path|maps}} folder with the same name as the associated [[BSP]].


*{{todo|What data types are there beside <code>file</code>?}}
==VGUI Resource Files==
*{{todo|Can a .res be safely [[BSPZIP]]ped?}}
Some resource files can be found in your /resource folder. Most of them are for [[VGUI]]. For more information, see [[RES file (VGUI)]].
 
== Tools ==
 
<!-- dodgy site which tries to install an unwanted Firefox extension when you visit! [[BSP2RES]] is a tool to create [[RES]] files for [[Counter Strike SOURCE]]:
http://stas.mail15.com -->
<!-- useless: won't work if there is more than one map present! [http://halflife2.filefront.com/file/HalfLife_2_CS_Source_ResMaker;34374 Resmaker]-->
*[http://www.facepunch.com/showthread.php?t=227769 www_mapadd.exe] automatically creates a resource list when a map is compiled, and can also upload both the map and textures to an FTP server.


== See also ==
== See also ==
 
*[[VGUI2]]
*[[BSPZIP]]
*[[BSPZIP]]
*{{vide|4.1}}
*[[PackBSP]]
*[[PackBSP]]
*[[Map Analyst]]
*[[Map Analyst]]
*[[Pakrat]]
*[[Pakrat]]
*[[Map_Resource_Extractor]]
[[Category:Level Design]]


[[Category:Level Design]] [[Category:Glossary]]
[[Category:File formats]]
[[Category:Files]]

Latest revision as of 21:03, 27 June 2025

English (en)中文 (zh)Translate (Translate)

A Resource list (.res file) accompanies a map. When the map is running, it directs the server to push arbitrary files to connecting clients.

While it is generally preferable to achieve this by using BSPZIP to embed the files into the map itself, there are occasional situations where only loose files and a .res will work.

Warning.pngWarning:Clients can choose to not loose sound files, or not download any files except the BSP itself! Prefer using BSPZIP or similar to pack custom content into the map when possible.

Example

Resources
{ 
	"materials/vdc/some_material.vmt"	"file"
	"materials/vdc/some_material.vtf"	"file"
}
Tip.pngTip:.txt, .res, .ain, and .nav files with the same name as the map are automatically pushed, and don't need to be included.
Tip.pngTip:If a .mdl file is listed, .vvd, .ani, .dx80.vtx, .dx90.vtx, .sw.vtx, .phy, and .jpg files with the same name and path as the .mdl will also automatically be pushed.
Todo: What data types are there beside file? It seems to not matter what type is specified, as long as the type definition isn't empty or absent.
Todo: Can a .res be safely BSPZIPped?

Files

A resource list must be located in the 🖿maps folder with the same name as the associated BSP.

VGUI Resource Files

Some resource files can be found in your /resource folder. Most of them are for VGUI. For more information, see RES file (VGUI).

See also