This article relates to the game "Counter-Strike 2". Click here for more information.
This article relates to the software/tool "Counter-Strike 2 Workshop Tools". Click here for more information.
This article's documentation is for Source 2. Click here for more information.

Source 2/Docs/Level Design/Maps Workshop: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
 
(46 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{lang|Counter-Strike 2: Maps Workshop Tools}}
{{LanguageBar}} {{Source 2 topicon}} {{CS2Tools topicons}}
 
Port maps and assets over to S2.
 
= Import Tool Documentation =
As part of CS2’s Workshop Tools, we have included a Python script for helping content creators to quickly port maps and assets over to S2. Before getting started there is some preparation work which must be done.
 
=== Prerequisites ===
==== Precompiled Content ====
Precompiled content (such as any custom vmt, vtf, mdl, etc.) must be located in the <nowiki>\steam\steamapps\common\counterstrike source 15\csgo</nowiki> folder.  For example:
 
<nowiki>\steam\steamapps\common\counterstrike source 15\csgo\materials\
\steam\steamapps\common\counterstrike source 15\csgo\models\</nowiki>
 
'''Notes:''' Any custom content archived in a .bsp will need to be extracted into the appropriate folders before importing. The import tool also requires a vmf, so if you only have a bsp for your map, you will need to decompile it to a .vmf. Finally, '''do not copy .vmf files to the above folder''' as it will confuse the import tool.
 
 
==== Source Map Files ====
Your map files (.vmfs) can live anywhere outside of <nowiki>\counterstrike source 15\</nowiki> as long as they are in a <nowiki>\maps\</nowiki> folder. Any prefab or instance vmfs referenced by your map must be in whatever subfolder structure is expected by the map. For example:
 
<nowiki>c:\mymapfolder\maps\mymap.vmf
c:\mymapfolder\maps\prefabs\mymapprefab.vmf
c:\mymapfolder\maps\instances\mymapinsstance.vmf</nowiki>
 
 
==== Source Texture Files ====
If you have uncompressed source files for textures, (tga, psd, etc.) the import tool will try to use those when importing materials, otherwise it will fall back to converting and recompressing vtf files (which can decrease texture quality). For this to be successful, make sure your source files are in a mirrored location of the vtfs in <nowiki>\steam\steamapps\common\counterstrike source 15\csgo\materials\</nowiki> For example:
 
<nowiki>c:\steam\steamapps\common\counterstrike source 15\csgo\materials\mymaterial\mytexture.vtf
c:\mymapfolder\materials\mymaterial\mytexture.tga</nowiki>
 
== Getting Started ==
=== 1. Installing Python 2.7.14 ===
To run the import script you will need to install Python 2.7.14 which you can grab here: https://www.python.org/downloads/release/python-2714/
 
=== 2. Setting Environment Variables ===
Next you will need to set two environment path variables so that Windows knows where your python installation lives and other import libraries in the <nowiki>Steam\steamapps\common\counterstrike source 15\game\csgo\bin\win64</nowiki> folder:
 
Press the Windows key+X to access the Power User Task Menu.
* In the Power User Task Menu, select the System option.
* In the System window, scroll to the bottom and click the About option.
* In the System > About window, click the Advanced system settings link at the bottom of the Device specifications section.
* In the System Properties window, click the Advanced tab, then click the Environment Variables button near the bottom of that tab.
* In the Environment Variables window (pictured below), highlight the Path variable in the System variables section and/or click the '''New''' button.
* Add a '''path''' variable with the Value being the path to where you installed Python, and the path to your <nowiki>counterstrike source 15\game\bin\win64</nowiki> folder , separated by a semicolon. e.g. <nowiki>C:\python27; C:\Program Files (x86)\Steam\steamapps\common\counterstrike source 15\game\bin\win64</nowiki>
* Do this for both '''User Variables''' and '''System Variables:'''
 
[[File:Maps import environment variables.png|1000px]]
 
'''Note:''' To be sure that the Path variables are applied properly, it may be necessary to restart your computer.
 
=== 3. Installing the Colorama Extension ===
Next you will need a Python extension called colorama. To install this, simply open up a command prompt (search for cmd in Windows Start Menu) and type
 
<nowiki>python -m pip install colorama</nowiki>
 
[[File:Maps colorama ext.png|thumb]]
 
=== 4. Creating a new Addon with the Workshop Tools ===
Before running an import, you will need to create a Workshop Tools addon so that the imported content has a valid destination. To make a new addon, simply launch the game with Workshop Tools, and from the UI click "Create New Addon" and take note of the name for later.
 
[[File:Maps create addon.png|thumb]]
 
=== 5. Locating the Import Script ===
First up is locating the python import script, which can be found in the following folder:
<nowiki>(YourSteamInstallFolder)\Steam\steamapps\common\counterstrike source 15\game\csgo\import_scripts</nowiki>
 
[[File:Maps import script.png|thumb]]
 
Once you have located the folder, you will want to open up a command prompt here. This can be done by simply typing "cmd" in Windows Explorer address bar and hitting enter:
 
[[File:Maps open command.png|thumb]]
 
'''Note:''' There is also an experimental GUI called <nowiki>import_map_community_gui.exe</nowiki> more info on this can be found at the end of this document.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 


Port maps and assets over to {{source2|4.1}}.


<br />
== [[Import Tool Documentation]] ==
As part of {{cs2|4.1}}'s Workshop Tools, we have included a Python script for helping content creators to quickly port maps and assets over to {{source2|4.1}}. Before getting started there is some preparation work which must be done.


<br />


== [[Post Import Fixup steps]] ==
== [[Post Import Fixup steps]] ==
Tips for fixing skyboxes, cleaning up meshes and converting cubemaps.  
Tips for fixing skyboxes, cleaning up meshes and converting cubemaps.  


== Hammer Minimum Specs ==
<br />
Hammer now leverages GPU accelerated raytracing to both preview and bake lighting for CS2 maps, drastically speeding up compile times, even on lower end hardware. As such, a GPU capable of raytracing is now required for Hammer to be fully functional.
 
'''GPU Minimum Specs:'''
* Nvidia 2060Ti 6gb
* AMD 6600XT
 
'''GPU Recommended Specs:'''
* Nvidia 2080Ti+
* AMD 6800XT+

Latest revision as of 01:56, 18 July 2024

English (en)Deutsch (de)Русский (ru)Українська (uk)中文 (zh)Translate (Translate)

Port maps and assets over to Source 2 Source 2.


Import Tool Documentation

As part of Counter-Strike 2 Counter-Strike 2's Workshop Tools, we have included a Python script for helping content creators to quickly port maps and assets over to Source 2 Source 2. Before getting started there is some preparation work which must be done.


Post Import Fixup steps

Tips for fixing skyboxes, cleaning up meshes and converting cubemaps.