View source for Commentary Editor

The [[Commentary Editor]] is an [[:Engine Tools|engine tool]] originally released with the {{src07|4}}. This tool allows the developer to set commentaries within specific map (via [[:point_commentary_node|commentary nodes]]), which in turn allows the players to get the behind the scenes view and comments from the developers standpoint. 

The tool creates [[Commentary_System|_commentary.txt files]].

== Game engines ==
{{confirm}}
# {{src07|4}} [[mod]]s
# {{src09|4}} mods
# {{src13|4}} mods

== Games ==
=== Valve ===
# {{as|4}} ''Missing required localization/res files, Tutorial Fix [[:Commentary Editor Fix For Alien Swarm|Here!]]''
# {{csgo|4}} ''Missing required localization/res files ,Must use "toolload comedit" console command to launch''
# {{dods|4}}
# {{hl2|4}} (including {{hl2ep1|4}} & {{hl2ep2|4}} and {{hl2lc|4}})
# {{l4d|4}}
# {{l4d2|4}}
# {{portal|4}}
# {{portal2|4}}
# {{tf2|4}}
=== Third-party ===
# {{bms|4}} ''Not compatible with [[Qt]] UI, add {{code|'''-oldgameui'''}} to launch game with [[VGUI]].''
# {{ddd|4}} ''Must use "toolload comedit" console command to to launch''
# {{GMOD|4}}

== Usage ==
To use it, run your game or mod with {{codeblock|preset=0|1=-tools -nop4}} on the command line and select 'Commentary Editor' from the Tools menu. Make sure that [[sv_lan]] is set to 1 in the console located in the lower-left corner (sv_lan 1).
{{Note|{{strata}}{{code|-nop4}} does not need to be specified, as Perforce integration has been stripped.}}

== Interface ==
[[File:CommentaryEditor.jpg]]

The first window on the left is the entity report window. On the lower right is the properties window, and bove that is the engine viewport.

# The '''Entity Report''' window lists all of the entities created. This is used when creating, deleting, and selecting entities used in the commentary.
# The '''engine viewport''' shows whatever the game is currently rendering. You can flip control to and from the game with {{key|F10}}, and maximise your view with {{key|F11}}.
# '''Properties''' is where the entity properties are edited. You must select an entity from the entity report window prior to editing.

{{Note|The file menu is pretty self explanitory}}
<table class="wikitable">
  <tr>
      <th>'''File'''</th>
      <th>'''Edit'''</th>
      <th>'''CommEdit'''</th>
      <th>'''View'''</th>
   </tr>
  <tr>
      <th>[[File:MaterialEditor FileMenu.jpg]]</th>
      <th>[[File:MaterialEditor EditMenu.jpg]]</th>
      <th>[[File:CommentaryEditor CommEditMenu.jpg]]</th>
      <th>[[File:CommentaryEditor ViewMenu.jpg]]</th>
   </tr>
<tr>
    <td>
*'''Open...'''     
*'''Save'''
*'''Save As...'''
*'''Close'''
*'''Recent'''
*'''Clear Recent'''
*'''Exit'''
   </td>
    <td>
*'''Undo'''

Shortcut keys {{key|Ctrl}} + {{key|Z}}

*'''Redo'''

Shortcut keys {{key|Shift}} + {{key|Ctrl}} + {{key|Z}}

*'''Describe Undo History'''
{{Confirm|What does this do??}}

*'''Clear Undo History'''

*'''Keyboard'''

Shortcut keys {{key|Shift}} + {{key|Ctrl}} + {{key|Alt}} + {{key|E}}

See setting key bindings
   </td>
    <td>
*Add New Commentary Nodes

Shortcut keys {{key|Ctrl}} + {{key|A}}
   </td>
    <td>
*'''Properties'''
Shows the Properties Window If Checked

*'''Entity Report'''
Shows the Entity Report Window If Checked

*'''Console'''
Shows the Console If Checked 

*'''Default Layout'''
Resets the layout to the defualt view
   </td>
</tr>
</table>

== Setting up ==


click file -> new 

The choose [[BSP]] File window opens

[[File:CommentaryEditor ChooseBSPFileW.jpg]]

select the map that will use the commentary nodes


== Opening Commentary Files ==

Click File -> Open

The "Choose Valve Commentary File" window Opens

[[File:CommentaryEditor OpenWindow.jpg]]

Select the txt file with "_commentary" in the filename


== General Positioning of Commentary Nodes & Targets ==

{{note|In addition to having the UI fixed, Alien Swarm must have sv_cheats set to 1, firstperson mode on, and asw_controls set to 0 before using the tool otherwise the point_commentary_node/info_target would not be placed properly.}}

{{note|{{l4d}}[[Left 4 Dead]] & {{l4d2}}[[Left 4 Dead 2]] versions of the editor allow you to place [[info_remarkable]] entites}}

'''Creating Nodes'''

on the Entity Report window click [[File:CommentaryEditor CreateNodesbtn.jpg]]

{{Note|You will get switched to the engine viewport.}}

Left click to place commentary nodes([[point_commentary_node]]) or target nodes([[info_target]])

Right click to switch between commentary nodes and target nodes

{{key|ESC}} to exit the mode

'''Removing Nodes'''

On the Entity Report Window, select the entity or entities to be removed and click [[File:CommentaryEditor Deletebtn.jpg]]

'''Look at selected node'''

On the Entity Report Window, select the entity tha you wish the camera in the engine viewport to face then click [[File:CommentaryEditor CenterViewbtn.jpg]]

== point_commentary_node Properties ==


After creating the necesary nodes, Select the node to be edited from the Entity Report Window then go to the Properties window.

Set the fallowing

*'''Commentary Node Name'''

::''Assigned name of the currently selected point_commentary_node''

*'''Audio'''

:'''Audio File'''

::''Audio of the Presenter or speaker''

:'''Speaker(s)'''

::''Name(s) of the speakers presenting''

:'''Synopsis'''

::''Brief summary of the topic (Optional)''

*'''Location'''

:'''Position''' (X Y Z Cordinates)

:'''Orientation''' (Pitch Yaw Roll)

*'''Camera Control'''

:'''View Position''' (Taget Node X Y Z)

::''Moves the camera to the position of the targeted node''

:'''View Target''' (Taget Node X Y Z)

::''Orients the camera to face the targeted node''

*'''Operations'''

:'''Start Console Commands'''

::''Commands to be run at the start of the commentary'' 

:'''End Console Commands'''

::''Commands to be run at the end of the commentary''

== info_target Properties ==

*'''Target Name'''

::''Assigned name of the currently selected info_target''

*'''Location'''

:'''Position''' (X Y Z Cordinates)

:'''Orientation''' (Pitch Yaw Roll)

== info_remarkable Properties ==

{{note|Only avalable in {{l4d}}[[Left 4 Dead]] & {{l4d2}}[[Left 4 Dead 2]]}} 

*'''Target Name'''

::''Assigned name of the currently selected info_remarkable''

*'''Location'''

:'''Position''' (X Y Z Cordinates)

:'''Subject'''
::''Subject text to be entered''


== Saving And Testing ==

To Save simply click [[File:CommentaryEditor Savebtn.jpg]] on the Entity Remport Window

To Test simply click [[File:CommentaryEditor SaveTestbtn.jpg]] on the Entity Remport Window and the map will reload with the commentary nodes in place

Press {{key|F10}} to swich modes

Press {{key|F11}} to swich the engine viewport sizes


== See also ==
*[[Commentary System]]
*[[info_target]]

[[Category:Engine Tools]]