Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 4.06 KB

README.md

File metadata and controls

90 lines (66 loc) · 4.06 KB

Automat

Build

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

Currently Automat's functionality is limited to keyboard macro recording & playback. It's fairly unstable but if you're lucky and it runs on your machine, it can be useful for automating some basic actions.

You can, of course, check it out just to see how the interface works - but don't assume that it's going to stay like that. It's very much a work in progress. Roadmap includes some pretty radical new features which will drastically change how it looks and works.

Current roadmap can be found here.

Downloading and Running

Automat can be downloaded from the releases page.

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

Contributing

First read ARCHITECTURE.md to get a general idea of how things are organized. Once you do that, you may try to clone the Automat repository and run it (build script should take care of everything for you - if not - you can report it as a bug).

The same commands should work on Linux and Windows:

git clone https://github.com/mafik/automat.git
cd automat
./run.py automat

License

Automat is licensed under the MIT license. Some of its components use slightly different but compatible licenses. This means that you are free to embed & resell Automat, as long as you follow the license terms.

Here is an overview of the licenses used by Automat's dependencies:

  • Skia: BSD 3-Clause
  • FastTrigo: BSD 3-Clause
  • HIDAPI: BSD 3-Clause
  • libXau: MIT/X Consortium License
  • libxcb: MIT/X Consortium License
  • libxcb-proto: MIT/X Consortium License
  • xorg-util-macros: MIT/X Consortium License
  • xorgproto: various licenses
  • concurrentqueue: BSD 2-Clause
  • PipeWire: (not linked statically) MIT + LGPL for some plugins
  • RapidJSON: MIT (tests rely on non-MIT licensed files but they're not used for release)
  • vk-bootstrap: MIT
  • Vulkan-Headers: Apache 2.0 + MIT
  • Noto Sans: Open Font License

Do your own due dilligence and check the licenses of the dependencies you use!

Credits

Sounds

Website