Craig Oates
5 years ago
3 changed files with 39 additions and 0 deletions
@ -0,0 +1,37 @@ |
|||||||
|
This section is for people with experience using DeathSocketCLI. 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 here. You can view the verbose commands using the following link; |
||||||
|
|
||||||
|
- [Console Program A.P.I](Console-Program-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. They are |
||||||
|
basically re-directs to their "main/verbose" commands. |
||||||
|
|
||||||
|
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. If you do not, the |
||||||
|
aliases make little sense. |
||||||
|
|
||||||
|
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. Thus, **here is the only place these aliases are |
||||||
|
documented**, apart from the actual source code. |
||||||
|
|
||||||
|
|Original Command|Alias| |
||||||
|
|----------------|:---:| |
||||||
|
|`add-default` |`ad` | |
||||||
|
|`add-grid` |`ag` | |
||||||
|
|`list-colours` |`lc` | |
||||||
|
|
||||||
|
## Aliases A.P.I. |
||||||
|
|
||||||
|
- `ad (image-path: string) (new-path: string)` |
||||||
|
- `ag (image-path: string) (num-rows: int) (num-columns: int) |
||||||
|
(pen-width: double) (pen-colour: Color) (new-path: string)` |
||||||
|
- `lc ()` |
Loading…
Reference in new issue