Skip to content

mafik/automat

Repository files navigation

Automat

License Last Commit Release Stars Steam

Automat's objective is to be able to semi-autonomously play a variety of games. It's the first step towards a more general environment for interacting with computers.

Status

Automat can:

  • record and replay keyboard & mouse macros
  • react to hotkeys
  • capture windows as bitmaps and perform basic OCR
  • run a subset of x86 assembly to perform simple logic operations
  • runs on Windows & Linux (X11)

Stability of Automat is rather poor but sufficient for use as a macro utility.

Automat is continuously developed. Its roadmap can be found here.

Downloading and Running

Automat can be downloaded from the releases page.

Release Process.md contains some more notes about Automat's release schedule.

Talks / Videos

In reverse chronological order:

Contributing

Discord

First, read ARCHITECTURE.md to get a general idea of how things are organized.

Second, download Automat's source code (you can do this by pressing the "Code" button above and selecting the "Download ZIP" option), extract it and enter its directory. Right click and on an empty area and select "Open in Terminal".

First-time users on Windows may then run Automat like so:

./run.bat automat

On Linux (and also on Windows - assuming you already have Python installed and associated with .py files):

./run.py automat

The build script should take care of everything for you - if not - you can report it as a bug. Be patient while it builds - it may take quite a bit of time to build everything the first time (expect at least an hour).

Once Automat builds, feel free to tweak its sources to your hearts content. Running the script again will rebuild Automat using your changes.

If you'd like to share your tweaks, you can do so through the GitHub's pull request system. To use it you'll have to "fork" this repository & apply your changes to the fork. It's a good opportunity to clean up the code. Once your changes are pushed to GitHub, you can use GitHub's website to create & send a pull request.

Over the course of this process you may encounter some issues. If you do - don't hesitate to ask AI chatbots for help. If you manage to fix some of these issues - then your fixes would be an amazing contribution for others that will follow your steps. Coding is hard - don't be discouraged by small failures - because ultimately it is those failures that will make you better at coding!

License

Automat is licensed under the MIT license. Some of its components use slightly different but compatible licenses.

For details, take a look at the contents of the LICENSES directory (this directory is distributed as part of Automat).

Credits

Default Background

  • Stork 1 -- Manfred Heyde -- License: Creative Commons Attribution-Share Alike 4.0
  • Stork 2 -- Ken Billington -- Creative Commons Attribution-Share Alike 3.0 Unported
  • Stork 3 -- yhoebeke -- Creative Commons Attribution-Share Alike 2.0 Generic

Sounds

Website

About

A tangible interface for virtual things

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Contributors