Commentary Editor: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 50: Line 50:
'''CommEdit'''
'''CommEdit'''


[[File:CommentaryEditor CommEditMenu.jpg]]
*Add New Commentary Nodes
*Add New Commentary Nodes


Line 56: Line 57:
'''View'''
'''View'''


 
[[File:CommentaryEditor ViewMenu.jpg]]
*'''Properties'''
*'''Properties'''
Shows the Properties Window If Checked
Shows the Properties Window If Checked


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


*'''Console'''
*'''Console'''
Line 76: Line 77:


The choose BSP File window opens
The choose BSP File window opens
[[File:CommentaryEditor ChooseBSPFileW.jpg]]


select the map that will use the commentary nodes
select the map that will use the commentary nodes




== Creating Commentary Nodes & Targets ==
== General Positioning of Commentary Nodes & Targets ==
 
'''Creating Nodes'''


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


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


Left click to place commentary nodes or target nodes
Left click to place commentary nodes or target nodes
Line 92: Line 97:
{{key|ESC}} to exit the mode
{{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'''


== Setting the Commentary Node Properties ==
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]]


== 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
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
Set the fallowing


*'''Commentary Node Name'''
*'''Commentary Node Name'''
''Assigned name of the currently selected Commentary Node''


*'''Audio'''
*'''Audio'''
Line 108: Line 120:
'''Audio File'''
'''Audio File'''


'''Speakers'''
''Audio of the Presenter or speaker''
 
'''Speaker(s)'''
 
''Name(s) of the speakers presenting''


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


*'''Location'''
*'''Location'''
Line 121: Line 139:


'''View Position''' (Taget Node X Y Z)
'''View Position''' (Taget Node X Y Z)
''Moves the camera to the position of the targeted node''


'''View Target''' (Taget Node X Y Z)
'''View Target''' (Taget Node X Y Z)
''Orients the camera to face the targeted node''


*'''Operations'''
*'''Operations'''


'''Start Console Commands'''
'''Start Console Commands'''
''Commands to be run at the start of the commentary''


'''End Console Commands'''
'''End Console Commands'''
''Commands to be run at the end of the commentary''
== Target Node Properties ==
*'''Target Name'''
''Assigned name of the currently selected Target''
*'''Location'''
'''Position''' (X Y Z Cordinates)
'''Orientation''' (Pitch Yaw Roll)
== 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 ==
== See Also ==
*[[Commentary System]]
*[[Commentary System]]
*[[point_commentary_node]]
*[[point_commentary_node]]
*[[info_target]]
*[[Engine tools]]
*[[Engine tools]]


Revision as of 18:06, 17 January 2012

Broom icon.png
This article or section needs to be cleaned up to conform to a higher standard of quality.
For help, see the VDC Editing Help and Wikipedia cleanup process. Also, remember to check for any notes left by the tagger at this article's talk page.

Stub

This article or section is a stub. You can help by expanding it.

The Commentary Editor is an engine tool available in Source 2007 and later. To use it, run your game or mod with -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). This tool is used to set up commentary nodes in a selected map.

Warning.pngWarning:you need to use the command: "toolload commedit" in console for Alien SwarmAlien Swarm to load


Interface

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.


File

MaterialEditor FileMenu.jpg

Note.pngNote:The file menu is pretty self explanitory
  • Open...
  • Save
  • Save As...
  • Close
  • Recent
  • Clear Recent
  • Exit


Edit

MaterialEditor EditMenu.jpg

  • Undo

Shortcut keys Ctrl + Z

  • Redo

Shortcut keys ⇧ Shift + Ctrl + Z

  • Describe Undo History
Confirm:What does this do??
  • Clear Undo History
  • Keyboard

Shortcut keys ⇧ Shift + Ctrl + Alt + E

See setting key bindings

CommEdit

CommentaryEditor CommEditMenu.jpg

  • Add New Commentary Nodes

Shortcut keys Ctrl + A

View

CommentaryEditor ViewMenu.jpg

  • 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


Setting up

click file -> new

The choose BSP File window opens

CommentaryEditor ChooseBSPFileW.jpg

select the map that will use the commentary nodes


General Positioning of Commentary Nodes & Targets

Creating Nodes

on the Entity Report window click CommentaryEditor CreateNodesbtn.jpg

Note.pngNote:You will get switched to the engine viewport.

Left click to place commentary nodes or target nodes

Right click to switch between commentary nodes and target nodes

ESC to exit the mode

Removing Nodes

On the Entity Report Window, select the entity or entities to be removed and click 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 CommentaryEditor CenterViewbtn.jpg

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 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

Target Node Properties

  • Target Name

Assigned name of the currently selected Target

  • Location

Position (X Y Z Cordinates)

Orientation (Pitch Yaw Roll)


Saving And Testing

To Save simply click CommentaryEditor Savebtn.jpg on the Entity Remport Window

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

Press F10 to swich modes

Press F11 to swich the engine viewport sizes

See Also

Map editors
Map compilers
VBSP VBSP • VVIS • VRAD • vmpi
Map tools
bspzip • glview • VBSP2 • vbspinfo
Model compilers
Model tools
Dmxconvert • Dmxedit • HLFaceposer HLFaceposer • HLMV HLMV • Itemtest • Modelbrowser • QC_Eyes
Texture tools
Height2Normal Height2Normal • height2ssbump • makevmt • mksheet • pfm2tgas • Shadercompile • Splitskybox • VTEX VTEX • VTF2TGA VTF2TGA • xwad
Sound tools
Engine tools
Other
Captioncompiler • Demoinfo • Elementviewer • MakeGameData • Motionmapper • Sfmgen • VConfig • Vfont • Vfont_decompiler • VICE • vpk
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Commentary_Editor&oldid=164225"