greg/no-more-secrets-rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README update

Browse Source 
modified:   README.md
This commit is contained in:
Brian Barto 2016-09-18 13:49:00 -04:00
parent 47b8fb8c56
commit 8057b00414
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -129,13 +129,12 @@ typedef struct {
Assign values to the structure members as needed.
| --- | --- |
| char *src | Pointer to the string of characters on which to perform the effect. |
| char *foreground_color | Pointer to a string containing the desired foreground color: white, yellow, black, magenta, blue, green, red. |
| char *return_opts | String pointer containing only the character options that the user must choose from once the `src` characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`. |
| int input_cursor_x, input_cursor_y | If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen coordinates for the position. |
| bool show_cursor | Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default. |
| bool auto_decrypt | Set to `true` to automatically start the decryption effect, eliminating the need for the user to press a key to start it. |
**char *src** Pointer to the string of characters on which to perform the effect.
**char *foreground_color** Pointer to a string containing the desired foreground color: white, yellow, black, magenta, blue, green, red.
**char *return_opts** String pointer containing only the character options that the user must choose from once the `src` characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`.
**int input_cursor_x, input_cursor_y** If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen coordinates for the position.
**bool show_cursor** Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default.
**bool auto_decrypt** Set to `true` to automatically start the decryption effect, eliminating the need for the user to press a key to start it.
Once you set the structure members as desired, simply pass a pointer to the structure to the nms_exec() function: