cromulant/arguments.md

162 lines
1.5 KiB
Markdown
Raw Normal View History

2024-07-27 03:56:41 +00:00
# Arguments
Here are all the available command line arguments:
---
### version
Check the version of the program
Action: version
---
### names
Path to a JSON file with a list of names. Use these instead of the default ones
Type: str
---
### ants
Path to a JSON file with ants data. Use this instead of the default one
Type: str
---
### no-images
Don't show the images on the left
Action: store_false
---
### no-header
Don't show the header controls
Action: store_false
---
### no-footer
Don't show the footer controls
Action: store_false
---
### no-intro
Don't show the intro message
Action: store_false
---
### title
Custom title for the window
Default: [Empty string]
Type: str
---
### width
The width of the window in pixels
Default: 0
Type: int
---
### height
The height of the window in pixels
Default: 0
Type: int
---
### program
The internal name of the program
Default: [Empty string]
Type: str
---
### speed
Use this update speed
Default: [Empty string]
Choices: "fast", "normal", "slow"
Type: str
---
### clean
Start with clean ants data
Default: False
Action: store_true
---
### fast-minutes
The number of minutes between fast updates
Default: 0.0
Type: float
---
### normal-minutes
The number of minutes between normal updates
Default: 0.0
Type: float
---
### slow-minutes
The number of minutes between slow updates
Default: 0.0
Type: float
---
### argdoc
Make the arguments document and exit
Default: False
Action: store_true