Update TUTORIAL.md

This commit is contained in:
LE LOUER Lucas 2023-08-21 18:00:59 +02:00 committed by GitHub
parent f10652f986
commit 5e4a946221
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 76 additions and 0 deletions

View File

@ -1 +1,77 @@
# Buttons
To start recording, you simply have to press the red button or the `o` key (By default).\
From there, you can move your mouse, click, and type on your keyboard, and everything will be recorded. (You can choose what will be recorded.)
Then, to stop the recording, you simply click on the black square or press the `escape` key (By default).\
To play a recording, you just need to click on the green play icon or press the `p` key (By it will open a file explorer window (if you haven't already saved yet).
From there you can chose you favorite path to save your record.
To load a record, you can do `ctrl + l` or by clicking on `File` and `Load` and it will open a file explorer window
From there, choose the record you want to play (json files only)
Finally, to start a new record and delete the last one, you can do `ctrl + n` or by clicking on `File` and `New`
And you'll have the software as if you were opening it for the first time.
# Options
### Speed
To change the speed, go to `Options` -> `Playback` -> `Speed` and change it to whatever value you want from 0.1 to 10.
A value less than 1 will make your record slower, and a value greater than 1 will make your record faster.
### Repeat
To change the amount of repeat, go to `Options` -> `Playback` -> `Repeat` and it to whatever value you want, from 1 to infite.
### Selecting what to record
To change your preferences from what being recorded, go to `Options` -> `Recordings` and you will see 3 options with checkmarks.
* Mouse mouvement
* Mouse click
* Keyboard
To change, simply click to the one you want to disable.
### Hotkeys
To change your hotkeys to start, stop, start playback and stop playback, go to `Options` -> `Options` -> `Hotkeys`.
A window will popup and you'll have 4 buttons, click on it and you'll be able to change your hotkeys.
Unfortunately, you can't have same hotkeys.
### Minimization
To change minimization settings, go to `Options` -> `Options` -> `Minimization` and you'll have two options.
\
\
One, `minimized while playing`, PyMacroRecord will be minimized while playing
\
Two, `minimized while recording`, PyMacroRecord will be minimized while recording
\
\
You'll have a popup when PyMacroRecord get minimized so you're not confused when PyMacroRecord disappear
### After Playback Options
To change the after playback events, go to `Options` -> `Options` -> `After Playback...`
\
You'll have a window with a menu where you can choose from:
* Idle (Default)
* Quit Software
* Standby
* Log off Computer
* Turn off Computer
* Hibernate (If activated)
# Others
To check your version of your current software, go to `Help` -> `About` and you'll have a window that show the publisher, the version if it is outdated or not and the license.
\
\
If you encounter any issue or you want to request an update. Please open an [issue](https://github.com/LOUDO56/PyMacroRecord/issues)!