v2.0.3
authorHarry Godden <thrustmediaproductions@gmail.com>
Mon, 18 Mar 2019 19:20:15 +0000 (19:20 +0000)
committerGitHub <noreply@github.com>
Mon, 18 Mar 2019 19:20:15 +0000 (19:20 +0000)
README.md

index a0fa24aaf4cb5049ef5bef7a93f3bc2fc38299de..983f9c0e54be09213a8c3e11757908e6e7ff9e48 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # CS:GO Auto Radar
 Automatically make a radar with every compile of a map you do:
 
-Specify the layout in hammer by adding brushes to a visgroup named 'tavr_layout', and Auto Radar will do the rest.
+Specify the layout in hammer by adding brushes to a visgroup named 'tar_layout', and Auto Radar will do the rest.
 
 ![](https://i.imgur.com/thAfDqx.png)
 
@@ -14,11 +14,6 @@ Notable things up ahead:
 
 Want to support development? https://www.paypal.me/terri00 :)
 
-# Usage Guide:
-This guide covers basic setup and usage of Auto Radar: http://www.harrygodden.com/blog/?article=auto-radar-alpha
-
-(Should be setup the same way vvis.exe or vrad.exe are)
-
 # Download:
 This tool requires Visual C++ 2017 redistributables, you can donwload them here (both should be installed if Auto Radar won't start):
 
@@ -27,51 +22,45 @@ This tool requires Visual C++ 2017 redistributables, you can donwload them here
 
 Download the latest release of AutoRadar here: https://github.com/Terri00/MCDV/releases
 
-Submit any issues on this git repository, and send suggestions to hgodden00@gmail.com / Terri00#1024 on discord
-
-# Configuration:
-### Command line options:
-The following options should be specified on the command line.
-```csharp
-// Set by hammer =============================================================
--g, --game                  string // (required) The game directory for csgo
--m, --mapfile               string // (required or positional) The mapfile
-
-// User commands =============================================================
--d, --dumpMasks                    // Outputs the masks next to the .exe
--o, --onlyMasks                    // Outputs the masks and does nothing else
+Run the AutoRadar_installer.exe to copy all the necessary files into the correct locations.
 
--w, --width                 int    // Render width (experimental)
--h, --height                int    // Render height (experimental)
+Submit any issues on this git repository, and send suggestions to hgodden00@gmail.com / Terri00#1024 on discord
 
---ao                               // Enables Ambient Occlusion in the radar
---shadows                          // Enables basic traced shadows in the radar
-```
-Example setup: `AutoRadar.exe -d --ao --shadows -g %1 %2`
+# Guide:
 
-Minimum setup: `AutoRadar.exe -g %1 %2` (Basic radar, no shadows or ambient occlusion)
+### Configuration: 
+![](https://i.imgur.com/w2M0Ap9.png)
 
-###### Where `%1` is the path to the `/Counter-Strike Global Offensive/csgo/` folder
-###### And `%2` is the path to the vmf file you want to compile for.
+Add a tar_config entity to your map. This defines your radars settings. It is not needed, but allows you to customize it.
 
-![None / AO / Shadows](https://i.imgur.com/J1dJkxi.png)
+#### Examples of the different effects:
+![](https://i.imgur.com/tE72qG2.png)
 
 ### Detected Visgroups:
-Brushes and entity brushes which are inside visgroups with these names will change the final radar in different ways. The only one required is `tavr_layout` and should define your maps playable space.
+![Visgroup example](https://i.imgur.com/fXozJkj.png)
+
+Brushes and entity brushes which are inside visgroups with these names will change the final radar in different ways. The only one required is `tar_layout` and should define your maps playable space.
 
 | Visgroup name | What it does                                            |
 |---------------|---------------------------------------------------------|
-| tavr_layout   | specifies the layout of the map (the floor)             |
-| tavr_negative | brushes that should subtract from the layout of the map |
-| tavr_cover    | brushes that should show up as cover in the radar (brushes in this group should also be in tavr_layout)      |
+| tar_layout   | specifies the layout of the map (the floor)             |
+| tar_mask | brushes that should subtract from the layout of the map, use this on walls |
+| tar_cover    | brushes that should show up as cover in the radar    |
 
 ### Detected Entities:
+![](https://i.imgur.com/PyPuPh5.png)
+
 Entities with these classnames get picked up by Auto Radar. They are not required, and the values will otherwise be automatically set.
 
 | Entity name     | What it does                                  |
 |-----------------|-----------------------------------------------|
-| tavr_height_min | Overrides the minimum height value of the map (place it at the lowest part of your map) |
-| tavr_height_max | Overrides the maximum height value (place it at the top of your map) |
+| tar_min | Overrides the minimum height value of the map (place it at the lowest part of your map) |
+| tar_max | Overrides the maximum height value (place it at the top of your map) |
+
+### Generating:
+![](https://i.imgur.com/Y1l9eDC.png)
+
+The AutoRadar installer set up a new compile profile in the 'expert' mode. Enter the compile mode, and select [TAR] Generate Radar from the list. The hit Go!
 
 ### Free software used:
 - Headers from the amazing STB collection: https://github.com/nothings/stb