Skip to content

Options

Ethan Chapman edited this page Sep 2, 2023 · 2 revisions

General options

Streaming Mod

  • Options: NTR, HzMod, ChirunoMod
  • Default: NTR
  • Description: The 3DS mod to connect to.

3DS IP

  • Options: any IP address. For the technical, it could be any network address in theory, including a URL, but this isn't officially supported.
  • Default: 0.0.0.0 (almost certainly will not work)
  • Description: The IP address of the 3DS. Can be found through various means, see basic usage.

Layout

  • Options: Separate, Vertical, Vertical (Inv), Horizontal, Horizontal (Inv), Top Only, Bottom Only
  • Default: Separate
  • Description: The layout of the two screens. Currently only supported in visual output. File streaming effectively uses top screen only while image sequence effectively uses separate.

Top Scale

  • Options: Any positive number
  • Default: 1.0
  • Description: Multiplicative factor to scale the top screen by.

Bottom Scale

  • Options: Any positive number
  • Default: 1.0
  • Description: Multiplicative factor to scale the bottom screen by.

Color Mode

  • Options: Regular, VC Blue Shift (Test), Grayscale
  • Default: Regular
  • Description: Effect to manually correct for color issues. VC Blue Shift (Test) improves HzMod colors for Virtual Console games, but it's definitely not perfect.

3DS Port

  • Options: Integer 0-65535
  • Default: Depends on mod
  • Description: The port Chokistream will attempt to connect to. Depends on mod. Chokistream will generally take care of this for you, but in some rare situations you may have hacked a mod to use a different port.

Log Mode

  • Options: Console, File, Both
  • Default: Console
  • Description: Where log output goes. If not running from a console, "Console" effectively does nothing and "Both" is effectively "File".

Log Level

  • Options: Regular, Verbose, Extreme
  • Default: Regular
  • Description: How much logging to enable. "Regular" will show you the most important messages, such as errors and warnings. "Verbose" will include significant debug logs. "Extreme" includes the above as well as all data received from the 3DS and significantly more information about data sent to the 3DS.

Log File

  • Options: Any possible filename
  • Default: chokistream.log
  • Description: What file to send logging output to in "File" and "Both" log modes.

Output Format

  • Options: Visual, File Streaming, Image Sequences
  • Default: Visual
  • Description: "Visual" displays the video on the screen. "File Streaming" streams to a video file. "Image Sequence" saves the frames as image files.

NTR Settings

Quality

  • Options: Integer 1-100 (maybe 0-100?)
  • Default: 70
  • Description: JPEG image quality

Priority Screen

  • Options: Top, Bottom
  • Default: Top
  • Description: Which screen to send more frequently. This allows for higher framerates for the priority screen at the expense of the non-priority screen.

Priority Factor

  • Options: Positive integer
  • Default: 8
  • Description: Factor for how frequently to send the priority screen compared to the non-priority screen.

QoS

  • Options: 0-100
  • Default: 26
  • Description: Networking packet priority value. Probably never makes a meaningful difference.

HzMod Settings

Quality

  • Options: Integer 0-100
  • Default: 70
  • Description: JPEG image quality. Set to 0 to request TGA instead, or just use...

Request TGA?

  • Options: on/off
  • Default: off
  • Description: Whether to request TGA (lossless) images instead of JPEG. Has the same effect as setting quality to 0, but you can save your old quality setting that way.

CPU Cap

  • Options: 0-100
  • Default: 0
  • Description: CPU limiter for certain HzMod versions. Not well-documented.

ChirunoMod Settings

Quality

  • Options: Integer 1-100
  • Default: 70
  • Description: JPEG image quality.

Request TGA?

  • Options: on/off
  • Default: off
  • Description: Whether to request TGA (lossless) images instead of JPEG.

CPU Cap

  • Options: 0-100
  • Default: 0
  • Description: CPU limiter. Might or might now work with ChirunoMod?

Requested Screen

  • Options: Top, Bottom, Both
  • Default: Top
  • Description: Which screen to send, or both.

Interlace?

  • Options: on/off
  • Default: off
  • Description: Whether or not to request interlaced images from ChirunoMod. This may be ignored by ChirunoMod.

File Streaming Settings

Video Codec

  • Options: ProRes
  • Default: ProRes
  • Description: Which code to use when encoding video files.

Video File

  • Options: Any possible file name
  • Default: out
  • Description: The file to stream video to, without the extension. The extension will be automatically added based on the codec.

Image Sequence Settings

Image Directory

  • Options: Any possible directory name
  • Default: out
  • Description: A folder to put frames in.

Image Prefix

  • Options: Any possible filename, essentially
  • Default:
  • Description: A prefix for the image files. Default is no prefix.