This page is a index to the software documentation. Click here for more information.

XBLAH's Modding Tool/Docs: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "{{Language subpage}} {{Stub}}")
 
No edit summary
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Language subpage}}
{{LanguageBar|title = XBLAH's Modding Tool Documentation}}
{{DIP topicon}}


{{Stub}}
<onlyinclude>[[File:XBLAH's Modding Tool v1.18.1 - Top menu.png|800px|thumb|{{xblahmt|4}} - Top menu]]
[[File:XBLAH's Modding Tool - Run Mod - Run Toolbar.png|thumb|800px|{{xblahmt|4}} - Toolbar]]
Documentation and guides on how to work with the {{xblahmt|4}}. To begin, in the '''Toolbar''', select a base game and the mod you want to work on. It will automatically detect all compatible {{gldsrc|4}}, {{source|4}} and {{source2|4}} based games you have installed through Steam. Additional libraries may be added manually.
{{clr}}</onlyinclude>
 
{{tabs|XBLAH's_Modding_Tool/Docs|goldsrc=1|source=1|source2=1|main=source}}
 
{{note|The tool will automatically set your Source SDK 2013 SP branch to 'upcoming', if you haven't already. You may have to wait a few moments until it restarts Steam and finishes updating.}}
{{note|The tool will automatically install Mapbase when it's selected in the Game List.}}
 
<table style="width: 100%">
<tr><td style="padding-right: 2px; vertical-align: top">
{{Table
|style = margin-bottom: 8px; width: 100%
|align = center
| {{tr
| {{th|colspan=2|Game}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Game/New Mod|Creating a Mod]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Creating a barebones {{source|4}} mod |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Game/Open Game Folder|Open Game Folder]]'''|dark=true|font-size=1.1em }}
  {{td| A shortcut to the selected base game folder |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Game/Refresh Mods|Refresh Mods]]'''|dark=true|font-size=1.1em }}
  {{td| Refresh the mod listing for the selected game |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%
|align = center
| {{tr
| {{th|colspan=2|Modding}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Run|Running a Mod]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| You can run mods straight from the tool, without restarting Steam |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Open Mod Folder|Open Mod Folder]]'''|dark=true|font-size=1.1em }}
  {{td| A shortcut to the selected mod folder |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/File Explorer|File Explorer]]'''|dark=true|font-size=1.1em }}
  {{td| Preview the files mounted into the game info |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Clean Files|Cleaning Temporary Files]]'''|dark=true|font-size=1.1em }}
  {{td| Remove unnecessary files |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Game Info|Game Info]]'''|dark=true|font-size=1.1em }}
  {{td| Edit general mod information |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Content Mount|Content Mount]]'''|dark=true|font-size=1.1em }}
  {{td| Edit the mounted content |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Chapters|Managing Chapters]]'''|dark=true|font-size=1.1em }}
  {{td| Create and modify single-player chapters |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Starting Maps|Starting Maps]]'''|dark=true|font-size=1.1em }}
  {{td| Select the starting maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Menu Items|Menu Items]]'''|dark=true|font-size=1.1em }}
  {{td| Add, modify or remove menu items |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Pack Files Manually|Pack Files Manually]]'''|dark=true|font-size=1.1em }}
  {{td| Compress selected files into a VPK |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Pack Subdirectory|Pack Subdirectory under MOD_NAME/custom/]]'''|dark=true|font-size=1.1em }}
  {{td| Convert a loose custom folder into a VPK |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Unpack Files|Unpack Files]]'''|dark=true|font-size=1.1em }}
  {{td| Extract a VPK into a custom folder |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Remove Duplicates|Remove Duplicates]]'''|dark=true|font-size=1.1em }}
  {{td| Delete duplicated assets |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Delete Mod|Delete Mod]]'''|dark=true|font-size=1.1em }}
  {{td| Delete the selected mod |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%
|align = center
| {{tr
| {{th|colspan=2|Animations}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Animations/Scene Editor|Scene Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Autoconfigure and run the Choreography Editor |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
}}
</div>
</td>
<td style="padding-left: 2px; vertical-align: top">
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Maps}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Maps/Map Editor|Map Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Autodownload, autoconfigure and run the Map Editor |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Maps/Compile|Compile]]'''|dark=true|font-size=1.1em }}
  {{td| Compile maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Maps/Decompile|Decompile]]'''|dark=true|font-size=1.1em }}
  {{td| Decompile maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Maps/Open Prefabs Folder|Open Prefabs Folder]]'''|dark=true|font-size=1.1em }}
  {{td| A shortcut to the prefabs folder |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Extract Used Assets|Extract Used Assets]]'''|dark=true|font-size=1.1em }}
  {{td| Copy assets used by selected maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Maps/Building Generator|Building Generator]]'''|dark=true|font-size=1.1em }}
  {{td| Create buildings out of voxels |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Models}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Models/Decompile|Decompile]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Decompile models |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Extract Used Assets|Extract Used Assets]]'''|dark=true|font-size=1.1em }}
  {{td| Copy assets used by selected maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Materials}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Materials/Material Editor|Material Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Create or modify materials and textures |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        <!--{{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Materials/WAD Editor|WAD Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Create or modify WADs |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}-->
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Materials/Skybox Editor|Skybox Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Create or modify skyboxes |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Materials/Details Editor|Details Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Create or modify detail props |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Mod/Extract Used Assets|Extract Used Assets]]'''|dark=true|font-size=1.1em }}
  {{td| Copy assets used by selected maps |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Particles}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Particles/Generate Particle Manifest|Generate Particle Manifest]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Generate a particle manifest based on mounted particle files |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Particles/Version Converter|Version Converter]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Convert a PCF file from another {{source|4}} game to a compatible format |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Scripts}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Scripts/Locatization Editor|Localization Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Localization strings can be added and edited through an intuitive UI |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Sounds}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Sounds/Soundscape Editor|Soundscape Editor]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Create or modify soundscapes |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Sounds/Generate Soundscape Manifest|Generate Soundscape Manifest]]'''|dark=true|font-size=1.1em }}
  {{td| Generate a [[Soundscape]] manifest based on the mounted soundscapes |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Sounds/Generate Game Sounds Manifest|Generate Game Sounds Manifest]]'''|dark=true|font-size=1.1em }}
  {{td| Generate a game sounds manifest based on the mounted game sounds |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
{{Table
|style = margin-bottom: 8px; width: 100%;
|align = center
| {{tr
| {{th|colspan=2|Options}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Options/Steam Libraries|Steam Libraries]]'''|dark=true|font-size=1.1em;width:30% }}
  {{td| Add custom Game libraries |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5);width:70%}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Options/Discord Presence|Discord Presence]]'''|dark=true|font-size=1.1em }}
  {{td| Manage your Discord presence when using the tool |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
        {{tr
| {{td| '''[[{{ROOTPAGENAME}}/Docs/Options/Advanced Features|Advanced Features]]'''|dark=true|font-size=1.1em }}
  {{td| Manage specific settings for the tool |color=#E3E1DF|style=text-shadow:0 1px 5px rgba(0,0,0,0.5)}}
}}
}}
</div>
</td></tr></table>

Latest revision as of 04:58, 3 June 2025

English (en)Translate (Translate)

Documentation and guides on how to work with the XBLAH's Modding Tool XBLAH's Modding Tool. To begin, in the Toolbar, select a base game and the mod you want to work on. It will automatically detect all compatible GoldSrc GoldSrc, Source Source and Source 2 Source 2 based games you have installed through Steam. Additional libraries may be added manually.

Note.pngNote:The tool will automatically set your Source SDK 2013 SP branch to 'upcoming', if you haven't already. You may have to wait a few moments until it restarts Steam and finishes updating.
Note.pngNote:The tool will automatically install Mapbase when it's selected in the Game List.