Craig Oates
5 years ago
1 changed files with 21 additions and 0 deletions
@ -0,0 +1,21 @@
|
||||
This section is for people with experience using SmoulderingBeachBallCLI. If you are new to the program, I recommend you stick to the verbose commands for now. When you are familiar with them, feel free to return. You can view the verbose commands using the following link; |
||||
|
||||
- [Console A.P.I.](Console-API) |
||||
|
||||
The aliases in this console program have limitations when compared to PowerShell or Bash. This is because the aliases are hard-coded. You cannot create them yourself, unless you alter the source code, nor do so at run-time. The reason for this is because these "aliases" are essentially a hack on how Console.Waterworks (C.W.) works. |
||||
|
||||
The main/only benefit of aliases is they reduce the amount of typing you need to do. Although, the short-hand nature of them means you need to already know the name of the full command first. |
||||
|
||||
Alias commands are not displayed in the console's "help" section or cheat sheet because I want to avoid confusion. It is not my intention to make first-time users feel like they have "two" sets of commands they need to learn. |
||||
|
||||
|Original Command|Alias| |
||||
|:--------------:|:---:| |
||||
|`draw-default` |`dd` | |
||||
|`draw-image` |`di` | |
||||
|`list-colours` |`lc` | |
||||
|
||||
## Aliases A.P.I. |
||||
|
||||
- `dd (image-width: int) (image-height: int)` |
||||
- `di (image-width: int) (image-height: int) (main-colour: string) (overlay-colour: string) (overlay-type: string) (file-path: string)` |
||||
- `lc ()` |
Loading…
Reference in new issue