Xog Editor

From Valve Developer Community
Jump to: navigation, search
XogScriptBac1.jpg

Xog Editor is a based on console commands in-game xog editor, avaible in Black Mesa Black Mesa. This editor can configure on the fly most properties of global xog and xog volume with instant results in game; you can also add new ones to see how they look at your level. Initially, it was planned to implement the editor via VGUI, but because VGUI is not easy to work with, Kim made xogscript.cfg, which can be executed once to bind various console commands to keys on the keyboard to make the process much easier.

Usage

Before Xog Editor usage, make a copy of your config.cfg file (for example config_copy.cfg), because Xog Editor rewrites some bindings. With a copy of the file, you will be able to restore all your binds quickly.

To activate Xog Editor, at first, open the console (usually this is ` bind), than enter in the console exec xogscript (it is also recommended to enter sv_cheats 1, this to have full access to the commands). After this, you will be automatically moved in developer 1, with this, some bindings will rewratted, and you'll see the message in the console.

So, the Xog Editor editor is now activated and you may already noticed orange box around entity that is under your crosshair.

This is bounding box, usually uses by game engine to tell when model can be seen by player to draw or not draw it (for performance). You also can see the lines which shows direction of entity, they are always located in origin.

In this case, both things shows you entity that you are targeting, so, technically you can select and edit any entity, but most commands will not produce any results. The only two entities you should interact with is newxog_global and newxog_volume.

To edit your xog entity, move your crosshair at it. You'll note the lines which shows direction of it, you'll see bounding box in case of xog volume as well.

Press Enter to select it (to deselect it, press Enter again). The bounding box and lines will disappear.

Now you can change xog properties. In total you can change 10 different properties. There are 5 buttons in total, one button for every two property, you switch between them by pressing on it.

To select one of the properties you want to change, press one of these buttons: F1 to F5 or 1 to 5 on numpad. See below for what each does. To get full list of binds - press * on numpad.

After property selection, you can increase or decrease property value. Use mouse wheel up to increase, or + on numpad. Use mouse wheel down to decrease, or - on numpad. The resulting value will be displayed in the console.

Note.pngNote:There are limits due to scripting limits. Most values don't have the limits, or they are much larger than can be set using this editor.

Once you have decided on the values, manually write them in Hammer. If you have lost some value, you can get full information about selected light source, press , or / on numpad.

To delete xog, press Delete, or . on numpad.

To disable Xog Editor, enter in the console exec xogscript.

Keypad List

This is full list of bind/commands.


  • F1 or 1 on numpad - Start Distance / End Distance.
  • F2 or 2 on numpad - Height Color Start / Height Color End.
  • F3 or 3 on numpad - Height Z Start / Height Z End.
  • F4 or 4 on numpad - Noise Contrast / Noise Multiplier.
  • F5 or 5 on numpad - Opacity Offset Bottom / Opacity Offset Top.


  • Enter - select/deselect xog.
  • Mause Wheel Up or + on numpad - increase value of selected property.
  • Mause Wheel Down or - on numpad - decrease value of selected property.
  • , or / on numpad - shows all values of selected xog.
  • * on numpad - shows all keypad binds.
  • Delete or . on numpad - removes any entity your crosshair is pointed at.

Unused Commands

Some commands are unsed. You still can use them via console when your xog is selected.

See also