RadGen: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (JimWood moved page RadGen legacy to RadGen over redirect)
(Replaced content with "{{lang}} {{infotable |download=https://radargenerator.github.io/ |discord=https://discord.gg/6RwR6SYBW6 |type=t2 |engine=3 |platform={{win|4}} }} '''RadGen''' (Radar Generator) is a tool for {{cs2|4}}. This tool can generate highly customisable overviews for maps using meshes, entities and/or materials, by assigning them to specific Selection Sets. It can also be used in either a Material based workflow, or a Selection Set based workflow. __NOTOC__ ==Installat...")
Tag: Replaced
Line 2: Line 2:


{{infotable
{{infotable
|download=https://discord.gg/6RwR6SYBW6
|download=https://radargenerator.github.io/
|discord=https://discord.gg/6RwR6SYBW6
|type=t2
|type=t2
|engine=3
|engine=3
Line 13: Line 14:
__NOTOC__
__NOTOC__
==Installation==
==Installation==
;Download .NET Runtimes
# Download the latest version here: https://radargenerator.github.io/
# Download and install the latest .NET 8 runtime
 
;Install RadGen
# Download and unzip the latest release. Then, inside the unzipped folder, run RadGen_Install.bat (located in the 'Setup' folder).
{{note|Make sure to unzip these files into their own folder, named the same as the zip. It should be something like this:  RadGen - v0.10.1}}
 
;Enabling/Disabling RadGen (unable to play online or see RadGen stuff in Hammer?)
# The changes to the two gameinfo.gi files currently disables you from playing online on official Valve servers.
# Run RadGen_Enable.bat and RadGen_Disable.bat to enable/disable the ability to play online vs the ability to see RadGen materials and entities inside Hammer.
{{note|CS2 must be closed to run these.}}
{{note|If CS2 receives an update, you may need to run RadGen_Enable.bat again.}}
{{note|RadGen can generate radars without being 'Enabled'.}}
 
;Generating a radar
# When opening the game with the tools, open the console and change the Convar Helper's 'Page' dropdown to one of the 'User Page' options.
# Click the cog on the right hand side, and choose 'Import Page'. Select the 'RadGen_vconsole_template.ini' file.
{{note|The template can be regenerated again to include new addons by clicking the 'Update Page Template' button, or running the 'RadGen_SetupConvarPage.bat' file in your 'Counter-Strike Global Offensive/RadGen' folder. This file will need to be imported again to show any changes.}}
# You should now see a list of buttons for the the main maps in your addons.
{{note|This will only work if your vmap is named the same as your addon in the /maps folder, or if it is the only vmap in there. You may need to edit those buttons to point to your vmap if this is not the case.}}
# 'Generate Radar' buttons will generate a radar for your map, and update it in-game.
# 'Update radar' buttons will update your existing radar it in-game. Useful when wanting to manually tweak a previously generated radar.
 
==Bundled Software==
Included with RadGen is Yanzl's '''RadarGen''' .sbsar file, which allows you to create a Valve style radar with ease using RadGen and Substance Designer.
# Enable '''Export Raw Masks''' in '''radgen_config'''.
# Generate the overview using RadGen. Raw mask files will be exported to the '''/_radgen_extras''' folder
# Drag the '''RadarGen''' .sbsar file (located in your '''Counter-Strike Global Offensive/RadGen''' folder) into Substance Designer, and use the raw mask files as inputs.
# Overwrite the original '''.tga''' radar file in your addon's '''/panorama/images/overheadmaps''' folder.
 
==Usage==
To get started, add a '''radgen_config''' entity into the map.
 
Two auto Visgroups are created automatically: 'RadGen - Point Entities' & 'RadGen - Mesh Entities'.
It is potentially recommended to disable these when compiling a level, as some meshes may be visible in-game when tied to certain entities.
 
[[Mesh_entity|Mesh Entities]] including Buyzones, Bombsites and Rescue Zones, are drawn by default.
For bombsites, it will use their bombsite letter set in the entity's keyvalue in hammer for the .txt file outputted.
 
[[Prop_Types_Overview|Props]] are supported and will display correctly for whichever selection set they are placed in. Props in the 'RadGen' selection set will be shown as cover as a default.
 
[[Info_overlay|Overlays]] are supported. You can use either the '''info_overlay''' entity or the more thorough '''radgen_info_overlay''' entity for this.
 
There is support for both prefabs and instances.
 
Subdivision of all power levels is supported.
 
There are two workflows supported by RadGen:
# [[Material]] based workflow
# Selection Set based workflow
{{note|These workflows can be used interchangeably, and at the same time. There are no configuration changes needed to work in either way.}}
 
To generate and update a radar, click the 'Generate' radar button for your addon's map in VConsole's Convar Helper page that uses the RadGen_vconsole_template.ini file (check the installation instructions).
To update a radar in game only, click the 'Update' radar button for your addon's map instead.
 
A '*vmap_name*.radgen.log' file is created next to your .vmap file when running RadGen. Take a look at this to view your radar's generation progress, or to search for errors.
 
==Workflow 1 ([[Material]] based)==
You may want to use separate meshes to your playable map itself.
Everything for the radar should go into a custom Selection Set named RadGen (including '''radgen_box''' mesh entities), excluding the point entities.
 
RadGen will only display mesh faces with a RadGen texture applied to them. These include Path, Overlap, Cover, Door, Ladder and Danger.
The Remove texture will disallow anything to display within its volume.
The Ignore texture will be completely ignored, and is just a nice way to show mesh faces you don't want to draw.
You can apply the textures to all faces on a mesh, but it may cause slight issues when using stroke around your meshes, so if you notice any slight issues with stroke then that is likely the cause. In this scenario, only apply the texture to the top face.
 
If you wish to create separate meshes using the RadGen materials for objectives, such as Buyzones, Bombsites and Rescue Zones, these meshes will take priority over the mesh entities.
 
===Selection Set===
{| class="standard-table"
|-
! Name !! Works with !! What to add !! Description
|- id="radgen"
| '''radgen'''
| [[Mesh_entity|Mesh Entities]], [[Point_entity|Point Entities]], [[Prop_Types_Overview|Props]], [[Info_overlay|Overlays]]
| Everything.
| Everything in here will be used when generating the overview.
|}
 
===[[Material|Materials]]===
These are the materials that can be used with the [[Material]] based workflow.
{| class="standard-table"
|-
! Image
! Material name
! Description
 
|- id="Path"
| [[File:RadGen_Path.png|64px]]
|'''radgen/path'''
| Displays a Path.
 
|- id="Overlap"
| [[File:RadGen_Overlap.png|64px]]
|'''radgen/overlap'''
| Displays an Overlap.
 
|- id="Cover"
| [[File:RadGen_Cover.png|64px]]
|'''radgen/cover'''
| Displays cover.
 
|- id="Remove"
| [[File:RadGen_Remove.png|64px]]
|'''radgen/remove'''
| Defines a volume to not display anything in.
 
|- id="Door"
| [[File:RadGen_Door.png|64px]]
|'''radgen/door'''
| Defines a volume as a Door.
 
|- id="Ladder"
| [[File:RadGen_Ladder.png|64px]]
|'''radgen/ladder'''
| Defines a volume as a Ladder.
 
|- id="Danger"
| [[File:RadGen_Danger.png|64px]]
|'''radgen/danger'''
| Defines a volume as a Danger.
 
|- id="Buyzone"
| [[File:RadGen_Buyzone.png|64px]]
|'''radgen/buyzone'''
| Defines a volume as a Buyzone.
 
|- id="Bombsite_A"
| [[File:RadGen_Bombsite_A.png|64px]]
|'''radgen/bombsite_a'''
| Defines a volume as a Bombsite A.
 
|- id="Bombsite_B"
| [[File:RadGen_Bombsite_B.png|64px]]
|'''radgen/bombsite_b'''
| Defines a volume as a Bombsite B.
 
|- id="Rescue_Zone"
| [[File:RadGen_Rescue_Zone.png|64px]]
|'''radgen/rescue_zone'''
| Defines a volume as a Rescue Zone.
 
|- id="Hostage"
| [[File:RadGen_Hostage.png|64px]]
|'''radgen/hostage'''
| Defines a volume as a Hostage.
 
|- id="T_Spawn"
| [[File:RadGen_T_Spawn.png|64px]]
|'''radgen/t_spawn'''
| Defines a volume as T Spawn.
 
|- id="CT_Spawn"
| [[File:RadGen_CT_Spawn.png|64px]]
|'''radgen/ct_spawn'''
| Defines a volume as CT Spawn.
 
|- id="Ignore"
| [[File:RadGen_Ignore.png|64px]]
|'''radgen/ignore'''
| Does nothing, an option for unused mesh sides.
 
|- id="RadGen_overlays"
| [[File:RadGen_Overlays.png|64px]]
|'''radgen/radgen_overlays'''
| Example for use on info_overlay and radgen_info_overlay entities. Optional.
 
|- id="RadGen_Box"
| [[File:RadGen_Box.png|64px]]
|'''radgen/radgen_box'''
| Example for use on radgen_box entities. Optional.
|}
 
==Workflow 2 (Selection Set based)==
You can also use the same workflow as [[TAR|TAR]] and [[JERC|JERC]] (CS:GO auto radar tools), avoiding the need of using the RadGen materials, and allowing you to use your already placed meshes for the overview.
The available selection sets are: 'radgen_remove', 'radgen_path', 'radgen_overlap', 'radgen_cover', 'radgen_door', 'radgen_ladder', 'radgen_danger'.
You will want to place anything else in the normal 'radgen' Selection Set, as done in the [[Material]] based workflow.
 
===Selection Sets===
{| class="standard-table"
|-
! Name !! Works with !! What to add !! Description
|- id="radgen_path"
| '''radgen_path'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Accessible path areas.
| The accessible ground areas the player can walk on.
|- id="radgen_overlap"
| '''radgen_overlap'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Accessible overlapping ground areas.
| The accessible path areas the player can walk on that are above a '''radgen_path''' area in the same overview level.
|- id="radgen_cover"
| '''radgen_cover'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Cover.
| The cover in the level, displayed on top of paths.
|- id="radgen_remove"
| '''radgen_remove'''
| Meshes, [[Mesh_entity|Mesh Entities]]
| Inaccessible path areas.
| The inaccessible path areas. Stops the overview including anything in this area. A workaround to messy meshwork.
|- id="radgen_door"
| '''radgen_door'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Doors.
| The doors in the level.
|- id="radgen_ladder"
| '''radgen_ladder'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Ladders.
| The ladders in the level.
|- id="radgen_danger"
| '''radgen_danger'''
| Meshes, [[Mesh_entity|Mesh Entities]], [[Prop_Types_Overview|Props]]
| Any dangerous places in the level.
| Adds a semi-transparent overlay on top of accessible paths in a level, denoting that these areas can damage players.
|- id="radgen"
| '''radgen'''
| [[Mesh_entity|Mesh Entities]], [[Point_entity|Point Entities]], [[Prop_Types_Overview|Props]], [[Info_overlay|Overlays]]
| Everything else.
| Any other materials/entities that do not have their own selection set should be added here, as they support the [[Material]] Based workflow only.
|}
 
==[[Entity|Entities]]==
These entities allow for greater customisation of radars.
{| class="standard-table"
|-
! Icon
! Classname
! Description
!width=50%| Keyvalues
 
|- id="radgen_config"
| [[File:RadGen_Config.png|64px]]
|'''radgen_config'''
| Configure the main functionality.
| {{ScrollBox| maxheight=32em|
{{KV|Workshop ID|intn=workshopId|string|Used for Danger Zone maps for duplicating the overview (for the tablet) into the correct location for packing}}
{{KV|Overview Gamemode Type|intn=overviewGamemodeType|choices|For export filepath purposes only. Standard = .../resource/overviews/..., Danger Zone = .../materials/models/weapons/v_models/tablet/... & .../materials/panorama/images/survival/spawnselect/...}}
:*0: Standard
:*1: Danger Zone
{{KV|Danger Zone Uses|intn=dangerZoneUses|choices|Defines which filepaths to export the overview to (only used if Overview Gamemode Type is set to Danger Zone)}}
:*0: Both
:*1: Tablet
:*2: Spawn Select
{{KV|Alternate Output Directory|intn=alternateOutputPath|string|DO NOT USE BACKSLASHES. An alternate base output directory. Leave blank if you want to output to /game/csgo/ only. Don't include /resource/overviews/. Eg. C:/Dropbox/RadGen/}}
{{KV|Only Output to Alternate Path|intn=onlyOutputToAlternatePath|choices}}
:*0: No
:*1: Yes
{{KV|Export Multilevel Radar|intn=exportRadarAsSeparateLevels|choices|Exports multiple separate radars (if there are any radgen_divider entities)}}
:*0: No
:*1: Yes
{{KV|Separate Multilevel Radar Gradients|intn=useSeparateGradientEachLevel|choices|Uses a new gradient for each level instead of one gradient for all levels combined}}
:*0: No
:*1: Yes
{{KV|Ignore Displacement X/Y Changes|intn=ignoreDisplacementXYChanges|choices|Ignores changes on the X and Y axis for subdivision displacements, as they can cause graphical bugs on overviews}}
:*0: No
:*1: Yes
{{KV|Use Model Vertices Instead of Bounding Box|intn=useModelVertices|choices|Uses model vertices to calculate faces to show as cover on the overview. When disabled, it uses bounding boxes.}}
:*0: No
:*1: Yes
{{KV|Background Image Filename|intn=backgroundFilename|string|For custom images, place them inside your addon's folder, like so: .../Counter-Strike Global Offensive/content/csgo_addons/{addon_name}/materials/RadGen/backgrounds/{filename}}}
{{KV|Radar Size Multiplier (float)|intn=radarSizeMultiplier|float|A multiplier for altering the size of the level in the radar}}
{{KV|Overlap Alpha (Whole Number)|intn=overlapAlpha|integer|The alpha value for overlap mesh sides (0-255)}}
{{KV|Danger Alpha (Whole Number)|intn=dangerAlpha|integer|The alpha value for danger mesh sides (0-255)}}
{{KV|Path Colour High|intn=pathColourHigh|color255|Colour of path world meshes at the highest point}}
{{KV|Path Colour Low|intn=pathColourLow|color255|Colour of path world meshes at the lowest point}}
{{KV|Overlap Colour High|intn=overlapColourHigh|color255|Colour of overlap world meshes  at the highest point}}
{{KV|Overlap Colour Low|intn=overlapColourLow|color255|Colour of overlap world meshes at the lowest point}}
{{KV|Cover Colour High|intn=coverColourHigh|color255|Colour of cover world meshes at the highest point}}
{{KV|Cover Colour Low|intn=coverColourLow|color255|Colour of cover world meshes at the lowest point}}
{{KV|Door Colour|intn=doorColour|color255|Colour of door world meshes}}
{{KV|Ladder Colour|intn=ladderColour|color255|Colour of ladder world meshes}}
{{KV|Danger Colour|intn=dangerColour|color255|Colour of danger world meshes}}
{{KV|Overlays Colour|intn=overlaysColour|color255|Colour of info_overlay and radgen_info_overlay (unless overridden) entities}}
{{KV|Stroke Width (Whole Number)|intn=strokeWidth|integer|Width of stroke to use}}
{{KV|Stroke Colour|intn=strokeColour|color255|Colour of the stroke}}
{{KV|Stroke Around Path Materials|intn=strokeAroundPathMaterials|choices}}
:*0: No
:*1: Yes
{{KV|Stroke Around Overlap Materials|intn=strokeAroundOverlapMaterials|choices}}
:*0: No
:*1: Yes
{{KV|Stroke Around Remove Materials|intn=strokeAroundRemoveMaterials|choices}}
:*0: No
:*1: Yes
{{KV|Stroke Around Entities|intn=strokeAroundEntities|choices}}
:*0: No
:*1: Yes
{{KV|Stroke Around Mesh Entities|intn=strokeAroundMeshEntities|choices|Currently, if there is more than one mesh in an entity, it will not combine them, so they will keep their individual borders}}
:*0: No
:*1: Yes
{{KV|Stroke Around Overlays|intn=strokeAroundOverlays|choices}}
:*0: No
:*1: Yes
{{KV|Default Level Num (Whole Number)|intn=defaultLevelNum|integer|The index that the default level is in a multilevel radar. 0 = bottom level, 1 = second from bottom level, ...}}
{{KV|Enable Levels As Backgrounds|intn=levelBackgroundEnabled|choices|Adds all levels as a background for each level when using multiple radar levels}}
:*0: No
:*1: Yes
{{KV|Levels Background Darken Alpha (Whole Number)|intn=levelBackgroundDarkenAlpha|integer|The alpha value of the black overlay to apply onto the background levels (0-255)}}
{{KV|Levels Background Blur Alpha (Whole Number)|intn=levelBackgroundBlurAmount|integer|The amount of gaussian blur to apply to the background levels}}
{{KV|Higher Level Output Name|intn=higherLevelOutputName|string|The higher level radar name RadGen uses for naming}}
{{KV|Lower Level Output Name|intn=lowerLevelOutputName|string|The lower level radar name RadGen uses for naming}}
{{KV|Export .TXT|intn=exportTxt|choices|Exported into your `...\content\csgo_addons\*addon_name*\panorama\images\overheadmap\` folder. Only exported if overview Gamemode Type is set to Standard}}
:*0: No
:*1: Yes
{{KV|Export .TGA|intn=exportTga|choices|Exported into your `...\content\csgo_addons\*addon_name*\panorama\images\overheadmap\` folder}}
:*0: No
:*1: Yes
{{KV|Export .PNG|intn=exportPng|choices|Exported into your `...\content\csgo_addons\*addon_name*\panorama\images\overheadmap\` folder}}
:*0: No
:*1: Yes
{{KV|Export .JPG|intn=exportJpg|choices|Exported into your `...\content\csgo_addons\*addon_name*\panorama\images\overheadmap\` folder}}
:*0: No
:*1: Yes
{{KV|Export Raw Masks|intn=exportRawMasks|choices|Exported into your `...\content\csgo_addons\*addon_name*\_radgen_extras\Overview\` folder. Exports raw masks which are designed for use with Yanzl's Substance Designer .sbsar file to make a clean radar imitating Valve's style}}
:*0: No
:*1: Yes
{{KV|Export Background Levels Image|intn=exportBackgroundLevelsImage|choices|Exported into your `...\content\csgo_addons\*addon_name*\_radgen_extras\` folder. Exports background levels image (if 'Export Multilevel Radar' is selected and there are any radgen_divider entities)}}
:*0: No
:*1: Yes
{{KV|Export Resolution (Whole Number)|intn=exportResolution|integer|Export resolution for each file format}}
{{KV|Max Num of Vertices Per Mesh Face (Whole Number)|intn=maxNumberOfVerticesPerMeshFaceLimit|integer|The maximum number of vertices a face can have for it to be included when creating the overview. Faces with more vertices than this will be ignored. Use with caution, as a high number and messy mesh topology can cause this to take a very long time.}}
{{KV|Use Subdivision|intn=useSubdivision|choices|EXPERIMENTAL - Uses subdivision displacement changes on appropriate meshes, rather than just the mesh's position.}}
:*0: No
:*1: Yes
}}
 
|- id="radgen_divider"
| [[File:RadGen_Divider.png|64px]]
|'''radgen_divider'''
| A divider between different levels of the radar.
|
{{KV|Mins|intn=mins|vector}}
{{KV|Maxs|intn=maxs|vector}}
 
|- id="radgen_ceiling"
| [[File:RadGen_Ceiling.png|64px]]
|'''radgen_ceiling'''
| Overrides the minimum height value of a radar level that is used for gradients.
|
 
|- id="radgen_floor"
| [[File:RadGen_Floor.png|64px]]
|'''radgen_floor'''
| Overrides the maximum height value of a radar level that is used for gradients.
|
 
|- id="radgen_info_overlay"
| [[File:RadGen_Info_Overlay.png|64px]]
|'''radgen_info_overlay'''
| An info_overlay with the ability to set a colour for this overlay instead of using the radgen_config's overlay colour.
|
{{KV|Pitch Yaw Roll (Y Z X)|intn=angles|string|This is the overlay direction. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, and roll is the rotation around the X axis. (Yaw is used for rotating the overlay in the overview)}}
{{KV|Material|intn=material|material}}
{{KV|Order Num (Whole Number)|intn=orderNum|integer|0 = First, 1 = Between Path And Overlap Meshes, 2 = After RadGen Meshes}}
{{KV|Override Colour|intn=overrideColour|choices|Uses the colour set on this entity instead of the radgen_config's overlay colour value}}
:*0: No
:*1: Yes
{{KV|Colour (R G B)|intn=rendercolor|color255}}
{{KV|Colour Alpha (Whole Number)|intn=colourAlpha|integer|The alpha value of the overlay (0-255)}}
{{KV|Stroke Colour (R G B)|intn=colourStroke|color255}}
{{KV|Stroke Colour Alpha (Whole Number)|intn=colourStrokeAlpha|integer|The alpha value of the overlay stroke (0-255)}}
 
|- id="radgen_box"
| [[File:RadGen_Box.png|64px]]
|'''radgen_box'''
| A [[Mesh_entity|Mesh Entity]] that can specify showing a unique colour when displayed in a radar. Increases customisability for what users can do.
An example of this would be to showcase the connections between different teleporters in a map.
|
{{KV|Order Num (Whole Number)|intn=orderNum|integer|0 = First, 1 = Between Path And Overlap Meshes, 2 = After RadGen Meshes, 3 = After Mesh Entities (eg. func_buyzone), 4 = After RadGen Meshes For Entities (eg. Bombsite A Material)}}
{{KV|Colour (R G B)|intn=rendercolor|color255}}
{{KV|Colour Alpha (Whole Number)|intn=colourAlpha|integer|The alpha value of the RadGen box (0-255)}}
{{KV|Stroke Colour (R G B)|intn=colourStroke|color255}}
{{KV|Stroke Colour Alpha (Whole Number)|intn=colourStrokeAlpha|integer|The alpha value of the RadGen box stroke (0-255)}}
{{KV|Stroke Width (Whole Number)|intn=strokeWidth|integer|Width of stroke to use}}
|}
 
===Customisation===
The options that can be tweaked to create the radar how you want it.
{| class="standard-table"
|-
! Image
 
|- id="radgen_config_customisation"
| [[File:Radgen config customisation.png|768px]]
|}
 
==Useful Links==
*[https://www.youtube.com/watch?v=vDhUOtkXiOM Eagle One Development Team - Radgen minimap creation - CS2 Mapping Academy #11 (Counter Strike 2)]
*[https://www.youtube.com/watch?v=Brw-BFEgScM Substance Designer example video for creating a Valve style radar]


==See also==
==See also==
*[https://discord.gg/6RwR6SYBW6 Download Page (Discord server)]
*[https://radargenerator.github.io/ Download page]
*[https://discord.gg/6RwR6SYBW6 Discord server]


{{sdktools/source2|0}}
{{sdktools/source2|0}}
[[Category: Third Party Source 2 Tools]]
[[Category: Third Party Source 2 Tools]]

Revision as of 20:39, 14 December 2024

English (en)Translate (Translate)
RadGen
Download
TypeThird Party Tool
EngineSource 2 Source 2
PlatformsWindows Windows
 
Join Discord server

RadGen (Radar Generator) is a tool for Counter-Strike 2 Counter-Strike 2. This tool can generate highly customisable overviews for maps using meshes, entities and/or materials, by assigning them to specific Selection Sets.

It can also be used in either a Material based workflow, or a Selection Set based workflow.

Installation

  1. Download the latest version here: https://radargenerator.github.io/

See also

Mod tools
Map editors
There are currently no tools in this list.
Map compilers
There are currently no tools in this list.
Map converters
Map tools
Model compilers
There are currently no tools in this list.
Model converters
Model tools
Particle converters
Texture converters
Texture tools
Sound tools
VPK tools
Libraries
There are currently no tools in this list.
Plugins
Other
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=RadGen&oldid=459309"