PyMacroRecord/TUTORIAL.md

101 lines
3.8 KiB
Markdown

# Buttons
To start recording, you simply have to press the red button.\
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.\
To play a recording, you just need to click on the green play icon.
# Save, Load and clear a record
To save a record, you can do `ctrl + s` or by clicking on `File` and `Save` or `Save as` and it will open a file explorer (if you haven't already saved yet).
From there you can choose you favorite path to save your record. You can either save it by `.pmr` extension (recommended) or by `.json` extension.
To load a record, you have two possibilities.
1. Open the a `.pmr` file
2. In the software, do `ctrl + l` or click on `File` and `Load` and it will open a file explorer.\
From there, choose the record you want to play (json and `.pmr` 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.
### Interval and For loop
To enable them, go to `Options` -> `Playback` -> `Interval` or `For` and you will have three value. Hours, Minutes and Seconds.
The value 0 in all three fields means you are disabling them, putting more than 0 in one field will enable them.
### Delay
To add a delay between repeats, go to `Options` -> `Playback` -> `Delay` and you can set the delay in seconds.
### 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 movement
* 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` -> `Settings` -> `Hotkeys`.
A window will popup and you'll have 4 buttons, click on it and you'll be able to change your hotkeys.
### Language
To change the language, go to `Options` -> `Settings` -> `Language`.
Then select the available language and then restart the software to take effect.
### Minimization
To change minimization settings, go to `Options` -> `Settings` -> `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` -> `Settings` -> `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
* Restart 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.
To reset your settings, go to `Options` -> `Others` -> `Reset settings`
To put a fixed timestamp, go to `Options` -> `Others` -> `Fixed timestamp`
To disable or enable check update, go to `Options` -> `Others` -> `Check update`
\
\
If you encounter any issue or you want to request an update. Please open an [issue](https://github.com/LOUDO56/PyMacroRecord/issues)!