From 69290c91d247ae5378049033ea355633467c9746 Mon Sep 17 00:00:00 2001 From: homeuser Date: Tue, 16 Oct 2018 11:51:27 +0200 Subject: [PATCH] README --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7ef6341..26286a6 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,18 @@ the directory to the PATH-Environment-Variable. # Documentation -| Command | Version Added | Syntax | Description | -| ------- | ------------- | ------ | ----------- | -| ANIMATION | v1 | `ANIMATION ` | Plays an animation. **MS** specifies the amount of Milliseconds per Frame, and **ANIMATION** is just all the animation frames seperated by spaces.
Example:
ANIMATION 200 U u .. u
Will animate to:
U u .. u U u .. u U u .. u U u .. u U u .. u

To have your code continue while the animation is running, call it with `START /B` | -| cTIME | v2 | `cTIME ` | Converts a Millisecond-Unix-Timestamp to human-readable time, ready to output. | -| CURSORPOS | v1 | `CURSORPOS ` | Sets the cursor to the given **X** and **Y** coordinates. **Y** is relative to the top of the entire current output, not necessarily the window. | -| CURSORVISIBILITY | v1 | `CURSORVISIBILITY` | Changes if the Cursor should be visible. | -| | | `CURSORVISIBILITY GET` | Outputs the current Cursor visibility state. | -| MAKEANIMATION | v1 | `MAKEANIMATION [WORD]` | Outputs a valid animation value for the `ANIMATION` command.

Types:
`Rotate`:
`0 - / - \ \|`
`1 - ^ > V <`
`2 - + x`
`3 - p d b q`
`Range`:
Returns a set of numbers from 0 to the given number.
`Alphabet`:
Returns **n** letters of the alphabet. Maximum is 26.
`Appear`
Accepts the **WORD** Parameter, while a *0* for **Sub** is required. It makes the given word appear one letter at a time. | -| PRINT | v1 | `PRINT ` | Prints the **String**. Only difference to the built-in `echo` is that no newline is added at the end. | -| STRLEN | v1 | `STRLEN ` | Returns the amount of characters in **String** in `%errorlevel%` | -| uTIME | v2 | `uTIME`
`uTIME -c` | Returns the current time as Millisecond-Unix-Timestamp. | -| | | `uTIME -f ` | Returns the last modification date for **File** as Millisecond-Unix-Timestamp. | -| | | `uTIME -fc ` | Returns the creation date for **File** as Millisecond-Unix-Timestamp. | -| xCOLOR | v1 | `xCOLOR ` | Sets the print color to **Color**, as seen in `color`, but only for the text after it. | -| xPRINT | v1 | `xPRINT ` | Reads the **File** as Instructions and executes them all at once.

`c00` - `Changes Color. (to 00 in this case.)`
`eHello` - `Prints something. ("Hello" in this case.)`
`n` - `New line.` | +| Command | Version Added | Syntax | Description | +| ---------------- | ------------- | ----------------------------------- | ----------- | +| ANIMATION | v1 | `ANIMATION ` | Plays an animation. **MS** specifies the amount of Milliseconds per Frame, and **ANIMATION** is just all the animation frames seperated by spaces.
Example:
ANIMATION 200 U u .. u
Will animate to:
U u .. u U u .. u U u .. u U u .. u U u .. u

To have your code continue while the animation is running, call it with `START /B` | +| cTIME | v2 | `cTIME ` | Converts a Millisecond-Unix-Timestamp to human-readable time, ready to output. | +| CURSORPOS | v1 | `CURSORPOS ` | Sets the cursor to the given **X** and **Y** coordinates. **Y** is relative to the top of the entire current output, not necessarily the window. | +| CURSORVISIBILITY | v1 | `CURSORVISIBILITY` | Changes if the Cursor should be visible. | +| | | `CURSORVISIBILITY GET` | Outputs the current Cursor visibility state. | +| MAKEANIMATION | v1 | `MAKEANIMATION [WORD]` | Outputs a valid animation value for the `ANIMATION` command.

Types:
`Rotate`:
`0 - / - \ \|`
`1 - ^ > V <`
`2 - + x`
`3 - p d b q`
`Range`:
Returns a set of numbers from 0 to the given number.
`Alphabet`:
Returns **n** letters of the alphabet. Maximum is 26.
`Appear`
Accepts the **WORD** Parameter, while a *0* for **Sub** is required. It makes the given word appear one letter at a time. | +| PRINT | v1 | `PRINT ` | Prints the **String**. Only difference to the built-in `echo` is that no newline is added at the end. | +| STRLEN | v1 | `STRLEN ` | Returns the amount of characters in **String** in `%errorlevel%` | +| uTIME | v2 | `uTIME`
`uTIME -c` | Returns the current time as Millisecond-Unix-Timestamp. | +| | | `uTIME -f ` | Returns the last modification date for **File** as Millisecond-Unix-Timestamp. | +| | | `uTIME -fc ` | Returns the creation date for **File** as Millisecond-Unix-Timestamp. | +| xCOLOR | v1 | `xCOLOR ` | Sets the print color to **Color**, as seen in `color`, but only for the text after it. | +| xPRINT | v1 | `xPRINT ` | Reads the **File** as Instructions and executes them all at once.

`c00` - `Changes Color. (to 00 in this case.)`
`eHello` - `Prints something. ("Hello" in this case.)`
`n` - `New line.` |