Revision Difference
Cinematic_Tools#522339
<cat>Dev</cat>⤶
<cat>Dev.Cinematic</cat>⤶
<title>Cinematic Tools</title>
This section outlines the available tools and commands related to cinematics and video content creation.
# Debug Camera
Introduction will be added here.
`debugcamera`
## Transform Controls
<key>W A S D</key> - Position the camera
<key>MOUSE</key> - Adjust pitch and yaw of the camera (i.e. look around)
<key>Q</key> - Raise camera height
<key>E</key> - Lower camera height
<key>Right Arrow</key> - Roll/rotate camera right or clockwise
<key>Left Arrow</key> - Roll/rotate camera left or anti-clockwise
<key>RIGHT MOUSE</key> + <key>MOUSE LEFT</key> / <key>MOUSE RIGHT</key> - Adjust roll/rotation of camera on the fly
## Field of View
<key>Z</key> or <key>+</key> - Zoom in (increase FOV amount)
<key>C</key> or <key>-</key> - Zoom out (decrease FOV amount)
<key>RIGHT MOUSE</key> + <key>MOUSE UP</key> / <key>MOUSE DOWN</key> - Adjust zoom (FOV amount) on the fly
## Reset Camera
Use the <key>R</key> key to reset the field of view and roll of the debug camera to the default state.
## Camera Speed
`debugcamera_speed <amount>` - Default value is 1.
## Look Speed
`debugcamera_lookspeed <amount>` - Default value is 1.
## Lerping
`debugcamera_lerp <amount>` - Default value is 1.
## Save Points
`debugcamera_save <name>`
`debugcamera_load <name>`
### Auto Save / Load
`debugcamera_autosave <0/1>`
`debugcamera_autoload <0/1>`
### List Save Points
`debugcamera_list` - Prints out all of the saved camera points; including name, position, rotation and zoom.
<note>This command is currently being developed and yet to be released.</note>
# Depth of Field
Enable depth of field using the command `dof 1`
## Aperture
`dof_aper <amount>` - Adjust the range of focus for the camera's depth of field, i.e. the area size which is in focus.
Smaller values produce a wider aperture, whilst higher values create a narrower focus range.
## Blur Amount
`dof_blur <amount>` - Specify the amount of blur applied in out of focus areas.
Decent results can be achieved by matching the blur amount to the [aperture](/rust/Cinematic_Tools#aperture) amount, then modifying from there.
## Focus Modes
Depth of field currently has two modes - **auto** and **manual** focus.
Use the command `dof_mode <0/1>` to switch between modes. `0` = auto, `1` = manual
## Auto Focus
This is the default mode for depth of field. Focus distance is automatically adjusted to a point of interest being looked at in the centermost part of the screen - eg. an entity (player, npc, deployable, etc) or a world object.
Auto focus is generally good for achieving quick results, but it's not perfect. For finer control use [manual mode.](/rust/Cinematic_Tools#manualfocus)
## Manual Focus
Manual mode allows setting focus to a specific distance from the camera by using the [focus distance](/rust/Cinematic_Tools#focusdistance) command and adjusting the time it takes to reach that distance by using the [focus time](/rust/Cinematic_Tools#focustime) command.
### Focus Distance
`dof_focus_dist <amount>` - Distance from camera to focus - measured in units.
### Focus Time
`dof_focus_time <amount>` - The time it takes (in seconds) to reach a new focus distance. 0 will be an instant change.
Useful for lerping between focus points triggered either by a bind or when [nudging](/rust/Cinematic_Tools#focusnudging) the focus distance.
### Focus Nudging
`dof_nudge <amount>` - Incrementally modify the focus distance by a specified amount. Both positive `+` and negative `-` values are accepted in the amount parameter, eg. `dof_nudge 1.5` will increase the focus distance by 1.5 units and `dof_nudge -1.5` will decrease it by 1.5 units.
Nudging is also useful when applied as a bind. You can pull focus by setting nudge amounts to the <key>mousewheel</key>
Example: `bind mousewheelup "dof_nudge 1.5"` and `bind mousewheeldown "dof_nudge -1.5"`
## Focus Debug
`dof_debug <0/1>` - Enable/disable a debug pass for depth of field - provides a 1:1 preview of focus settings.
Black = in focus, white = out of focus.
# Demos
## Recording
## Playback
# NPC Players
## Creating Bots
## Manipulating
# Other Commands
## Spawning
## Admin Time