easymacros/README.md

# easymacros

This program is inspired by [**xmacro**](https://github.com/Ortega-Dan/xmacroIncludingDelayCapturing/), however it isn't `xmacro`.

**Note**: This program is for personal use; I will modify it as I deem necessary, but feel free to open issues for suggestions or bug reports. Contributions are welcome! 

#

<details>
<summary><h2>:pen_ballpoint: TODOs :notepad_spiral:</h2></summary>

- [x] Playing macros (xmacro like)
  - [x] Delay support
  - [x] KeySym/KeyCode/KeyStr action support
  - [x] MotionNotify and button support
  - [x] String typing support (Not too high priority, but I'll add it some time probably)
  - [x] ExecBlock/ExecNoBlock support (not high priority)
    - [x] ExecBlock
    - [x] ExecNoBlock
- [x] Recording macros (xmacro like)
  - [x] Delay
  - [x] Keyboard actions
  - [x] Mouse actions
- [x] Utilities for playing macros
  - [ ] Ignoring delays when playing
  - [x] Event delay support
- [ ] macro configuration language
  - [ ] basic interpreter/compiler to fast intermediate lang
  - [ ] stdlib
    - [ ] xlib stuff (get window handles/ids)
	- [ ] easy xtst/xrecord etc abstractions
	- [ ] number/text inputs
	- [ ] clipboard
	- [ ] basic gui features
	- [ ] filesystem stuff
	- [ ] shell stuff
  - [ ] event listeners

#

</details>

<details>
<summary><h2>❔ Ideas 🧠</h2></summary>

I may or may not do these, but they sound fun to implement to me!

- [ ] additional macro features
  - [ ] relative cursor movements
  - [ ] screenshotting whole/parts ot the screen (using external programs)
- [ ] Macro daemon kind of thing to listen in the background for keyboard shortcuts?
  - [ ] the daemon itself
  - [ ] config file
  - [ ] rofi integration
  - [ ] dmenu integration
  - [ ] custom macro manager
- [ ] macro language?
  - [ ] Sending keys
  - [ ] mouse movements/events
  - [ ] control flow stuff/math/just normal scripting language stuff
  - [ ] reading/writing to clipboard
  - [ ] calling/recording other macros
  - [ ] running commands
- [ ] GUI Macro editor which is actually user friendly
#
</details>

<details>
<summary><h2>:desktop: Platform support :compression:</h2></summary>

- [x] Linux x11 (*only tested on `i3wm`*)
- [ ] Linux Wayland (*makes heavy use of X apis, I will only do this if I myself switch to Wayland. I'm open to suggestions how to do it though!*)
- [ ] MacOS (*Might work because of [XQuartz](https://www.xquartz.org/)?*)
- [ ] Windows (*Yeah, I'm not doing that myself. Unless I have to use Windows for anything.*) <!--(gentoolinux-girl): We both know you are not using Windows. xD-->
#
</details>

<details>
<summary><h2>:inbox_tray: Installation :newspaper:</h2></summary>

Currently only manually possible via `cargo build --release` and then moving the result into your `$PATH`.
#
</details>
NO EXCESS WHITESPACE IN MY CHRISTIAN MARKDOWN FILE 2022-06-30 07:57:12 +00:00			`# easymacros`
what 2022-06-11 22:50:02 +00:00
Fix misslinked `xmacro` 2022-06-30 08:18:44 +00:00			This program is inspired by [xmacro](https://github.com/Ortega-Dan/xmacroIncludingDelayCapturing/), however it isn't `xmacro`.
added basic xmacro support! now can record macros! 2022-06-15 10:50:44 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`Note: This program is for personal use; I will modify it as I deem necessary, but feel free to open issues for suggestions or bug reports. Contributions are welcome!`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`#`

			`<details>`
			`<summary><h2>:pen_ballpoint: TODOs :notepad_spiral:</h2></summary>`
added basic xmacro support! now can record macros! 2022-06-15 10:50:44 +00:00
Implemented "String" playing! Should now be compatible with xmacro yay 2022-07-03 14:52:53 +00:00			`- [x] Playing macros (xmacro like)`
added basic xmacro support! now can record macros! 2022-06-15 10:50:44 +00:00			`- [x] Delay support`
			`- [x] KeySym/KeyCode/KeyStr action support`
			`- [x] MotionNotify and button support`
Implemented "String" playing! Should now be compatible with xmacro yay 2022-07-03 14:52:53 +00:00			`- [x] String typing support (Not too high priority, but I'll add it some time probably)`
Implemented ExecNoBlock command support too. This really would've fit into one commit. 2022-07-01 10:11:09 +00:00			`- [x] ExecBlock/ExecNoBlock support (not high priority)`
Implemented ExecBlock command support. 2022-07-01 10:08:27 +00:00			`- [x] ExecBlock`
Implemented ExecNoBlock command support too. This really would've fit into one commit. 2022-07-01 10:11:09 +00:00			`- [x] ExecNoBlock`
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`- [x] Recording macros (xmacro like)`
			`- [x] Delay`
			`- [x] Keyboard actions`
			`- [x] Mouse actions`
updated todos and bumped version 2022-07-25 15:16:06 +00:00			`- [x] Utilities for playing macros`
"started" working on event_delay support. and added to the TODOs. 2022-07-11 10:18:43 +00:00			`- [ ] Ignoring delays when playing`
updated todos and bumped version 2022-07-25 15:16:06 +00:00			`- [x] Event delay support`
started working on additional TODOs 2022-08-15 12:28:42 +00:00			`- [ ] macro configuration language`
			`- [ ] basic interpreter/compiler to fast intermediate lang`
			`- [ ] stdlib`
			`- [ ] xlib stuff (get window handles/ids)`
			`- [ ] easy xtst/xrecord etc abstractions`
			`- [ ] number/text inputs`
			`- [ ] clipboard`
			`- [ ] basic gui features`
			`- [ ] filesystem stuff`
			`- [ ] shell stuff`
			`- [ ] event listeners`

Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`#`
started working on additional TODOs 2022-08-15 12:28:42 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`</details>`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`<details>`
			`<summary><h2>❔ Ideas 🧠</h2></summary>`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00
			`I may or may not do these, but they sound fun to implement to me!`

			`- [ ] additional macro features`
fixed list formatting added todo checkboxes 2022-06-15 12:24:13 +00:00			`- [ ] relative cursor movements`
			`- [ ] screenshotting whole/parts ot the screen (using external programs)`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00			`- [ ] Macro daemon kind of thing to listen in the background for keyboard shortcuts?`
			`- [ ] the daemon itself`
			`- [ ] config file`
			`- [ ] rofi integration`
			`- [ ] dmenu integration`
			`- [ ] custom macro manager`
			`- [ ] macro language?`
			`- [ ] Sending keys`
			`- [ ] mouse movements/events`
			`- [ ] control flow stuff/math/just normal scripting language stuff`
			`- [ ] reading/writing to clipboard`
			`- [ ] calling/recording other macros`
			`- [ ] running commands`
			`- [ ] GUI Macro editor which is actually user friendly`
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`#`
			`</details>`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`<details>`
			`<summary><h2>:desktop: Platform support :compression:</h2></summary>`
Just wrote down some ideas, none of thesse are actual announcements or anything. 2022-06-15 11:45:37 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			- [x] Linux x11 (only tested on `i3wm`)
			`- [ ] Linux Wayland (makes heavy use of X apis, I will only do this if I myself switch to Wayland. I'm open to suggestions how to do it though!)`
			`- [ ] MacOS (Might work because of [XQuartz](https://www.xquartz.org/)?)`
			`- [ ] Windows (Yeah, I'm not doing that myself. Unless I have to use Windows for anything.) <!--(gentoolinux-girl): We both know you are not using Windows. xD-->`
			`#`
			`</details>`
formatted with cargo, cleaned up imports and dependencies. 2022-06-15 12:06:27 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			`<details>`
			`<summary><h2>:inbox_tray: Installation :newspaper:</h2></summary>`
formatted with cargo, cleaned up imports and dependencies. 2022-06-15 12:06:27 +00:00
Basic enhancement to Markdown. 2022-06-30 07:55:57 +00:00			Currently only manually possible via `cargo build --release` and then moving the result into your `$PATH`.
			`#`
			`</details>`