Skip to content

Command Line

GitHub Action edited this page Nov 29, 2024 · 100 revisions
#***************************************
#*            dev1+revc440b01-modified *
#* This is a DEV version. Features may *
#* behave unexpectedly, or not at all. *
#***************************************

USAGE: 

   ./MK404  [--markdown] [-b] [--bootloader-file <file:hex>]
            [--colour-extrusion] [--complete-bash] [--complete-zsh] [-d]
            ... [--debugcore] [--extrusion <Line|Quad_Avg|Quad_HR|Tube_Avg
            |Tube_HR>] [-F <file:hex|afx|elf>] [-f <file:hex|afx|elf>] [-g
            <none|lite|fancy|bear>] [--gdb2] [--gdb] [--image-size <128M|1G
            |256M|2G|32M|512M|64M>] [-k] [--klipper] [--lcd-scheme <0|1|2>]
            [--legacythermal] [-l] [--marlin] [-m] [-n] [-p <enabled
            |disabled>] [--script <file:txt>] [--scripthelp] [--sdimage
            <file:img|bin>] [-s] [--skew-correct] [--test] [--terminal] [-t
            <string>] ... [--tracerate <integer>] [-v] ... [-w] [--]
            [--version] [-h] <IPCPrinter|IPCPrinter_MMU2|Prusa_CW1
            |Prusa_CW1S|Prusa_MK1_mR13|Prusa_MK25S_mR13|Prusa_MK25_mR13
            |Prusa_MK2MMU_mR13|Prusa_MK2_mR13|Prusa_MK3|Prusa_MK3MMU2
            |Prusa_MK3S|Prusa_MK3SMMU2|Prusa_MMU2|Test_Printer>


Where: 

   --markdown
     Used to auto-generate the items in refs/ as markdown

   -b,  --bootloader
     Run bootloader on first start instead of going straight to the
     firmware.

   --bootloader-file <file:hex>
     Specifies a .hex file to load as the bootloader. If empty, () no
     bootloader is loaded, if unspecified the default is used.

   --colour-extrusion
     Colours extrusion by width (for advanced step/extrusion debugging.

   --complete-bash
     Generate bash auto-complete script for supported arguments

   --complete-zsh
     Generate zsh auto-complete script for supported arguments

   -d,  --debug  (accepted multiple times)
     Increases debugging output, where supported.

   --debugcore
     Uses a debug version of the chip with more flash space.
     Board-dependent.

   --extrusion <Line|Quad_Avg|Quad_HR|Tube_Avg|Tube_HR>
     Set Print visual type. HR options create a LOT of triangles, do not
     use for large prints!

   -F <file:hex|afx|elf>,  --firmware2 <file:hex|afx|elf>
     secondary hex/afx/elf Firmware file to load to MMU, if present
     (default MM-control-01.hex)

   -f <file:hex|afx|elf>,  --firmware <file:hex|afx|elf>
     hex/afx/elf Firmware file to load (default MK3S.afx)

   -g <none|lite|fancy|bear>,  --graphics <none|lite|fancy|bear>
     Whether to enable fancy (advanced) or lite (minimal advanced) visuals.
     If not specified, only the basic 2D visuals are shown.

   --gdb2
     Enable SimAVR's GDB support on the MMU/secondary board

   --gdb
     Enable SimAVR's GDB support

   --image-size <128M|1G|256M|2G|32M|512M|64M>
     Specify a size for a new SD image. You must specify an image with
     --sdimage

   -k,  --keys
     Prints the list of available keyboard controls

   --klipper
     Synonym for --skew-correct and --no-hacks

   --lcd-scheme <0|1|2>
     Sets the default LCD colour scheme index, 0, 1, or 2

   --legacythermal
     Use the legacy thermal model for the nozzle heater.

   -l,  --loadfw
     Directs the printer to load the default firmware file. (-f implies -l)
     If neither -l or -f are provided, the printer executes solely from its
     persisted flash.

   --marlin
     Synonym for --no-hacks

   -m,  --mute
     Tell a printer to mute any audio it may produce.

   -n,  --no-hacks
     Disable any special hackery that might have been implemented for a
     board to run its manufacturer firmware, e.g. if you want to run stock
     marlin and have issues. Effects depend on the board and firmware.

   -p <enabled|disabled>,  --softPWM <enabled|disabled>
     enable/disable software PWM (currently only valid for MK2)

   --script <file:txt>
     Execute the given script. Use --scripthelp for syntax.

   --scripthelp
     Prints the available scripting commands for the current
     printer/context

   --sdimage <file:img|bin>
     Use the given SD card .img file instead of the default

   -s,  --serial
     Connect a printer's serial port to a PTY instead of printing its
     output to the console.

   --skew-correct
     Attempt to correct for fast clock skew of the simulated board

   --test
     Run it test mode (don't auto-exit due to lack of GL event loop and
     waiting for the window to close)

   --terminal
     Enable an in-UI terminal for interactive scripting
     (--EXPERIMENTAL!!--)

   -t <string>,  --trace <string>  (accepted multiple times)
     Enables VCD traces for the specified categories or IRQs. use '-t ?' to
     get a printout of available traces

   --tracerate <integer>
     Sets the logging frequency of the VCD trace (default 100uS)

   -v,  --verbose  (accepted multiple times)
     Increases verbosity of the output, where supported.

   -w,  --wait
     Wait after the printer (and any PTYs) are set up but before starting
     execution.

   --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

   --version
     Displays version information and exits.

   -h,  --help
     Displays usage information and exits.

   <IPCPrinter|IPCPrinter_MMU2|Prusa_CW1|Prusa_CW1S|Prusa_MK1_mR13
      |Prusa_MK25S_mR13|Prusa_MK25_mR13|Prusa_MK2MMU_mR13|Prusa_MK2_mR13
      |Prusa_MK3|Prusa_MK3MMU2|Prusa_MK3S|Prusa_MK3SMMU2|Prusa_MMU2
      |Test_Printer>
     Model name of the printer to run


   MK404 is an 8-bit AVR based 3D printer simulator for firmware debugging
   and tinkering.

   Copyright 2020 VintagePC <https://github.com/vintagepc/> with
   contributions from leptun, wavexx and 3d-gussner.

Clone this wiki locally