autogame 0.0
A python framework for automatic game playing, which can be used to develop automatic game scripts.
License: MIT
Keywords: automatic game python development script

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]


<br />
<p align="center">
  <a href="https://github.com/invokerrrr/autogame-python">
    <img src="https://github.com/invokerrrr/autogame-python/images/logo.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">Auto Game</h3>

  <p align="center">
    A python framework for automatic game playing, which can be used to develop automatic game scripts.
    <br/>
    <a href="https://github.com/invokerrrr/autogame-python"><strong>Explore the docs »</strong></a>
    <br/>
    <br/>
    <a href="https://github.com/invokerrrr/autogame-python">View Demo</a>
    ·
    <a href="https://github.com/invokerrrr/autogame-python/issues">Report Bug</a>
    ·
    <a href="https://github.com/invokerrrr/autogame-python/issues">Request Feature</a>
  </p>
</p>


## About The Project

Now many games in the market need to log in every day and do similar operations repeatedly, which is very time-consuming and boring. 
Therefore, I want to create a program that can automatically play games instead of us.
I need a general auto game library to achieve my goal.
The library should have these features:
* Firstly, I need an API of games simulators, which can capture the game outputs through images (sounds may be captured in the future), and enter inputs into the game similar to mouse and keyboard, etc.; 
* Secondly, it should integrate most image algorithms to identify key information quickly and accurately in the game scene; 
* Moreover, a GUI interface is also necessary for users, and so on.
There are many automatic game playing frameworks available on GitHub, however, I didn't find one that really suit my needs, so I created this.
Maybe this library can also meet your needs.


## Getting Started

To use this library just running follow these simple example steps.

### Prerequisites

This is a library written in Python, so you need to ensure that [Python](https://www.python.org) exists.

### Installation


```shell
pip install autogame-python
```

### Usage

```python
import autogame
```

<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_


## Roadmap

See the [open issues](https://github.com/invokerrrr/autogame-python/issues) for a list of proposed features (and known issues).


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork this Project.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the Branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.


## License

Distributed under the MIT License. See `LICENSE` for more information.


## Contact

Invoker - invoker-bot@outlook.com
Project Link: <https://github.com/invokerrrr/autogame-python>


## Acknowledgements
* [Simple Logo Generator](https://github.com/creecros/simple_logo_gen.git)
* [Best README Template](https://github.com/othneildrew/Best-README-Template.git)
* [Img Shields](https://shields.io)
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Pages](https://pages.github.com)
* [Animate.css](https://daneden.github.io/animate.css)
* [Loaders.css](https://connoratherton.com/loaders)
* [Slick Carousel](https://kenwheeler.github.io/slick)
* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
* [Sticky Kit](http://leafo.net/sticky-kit)
* [JVectorMap](http://jvectormap.com)
* [Font Awesome](https://fontawesome.com)


[contributors-shield]: https://img.shields.io/github/contributors/invokerrrr/autogame-python.svg?style=for-the-badge
[contributors-url]: https://github.com/invokerrrr/autogame-python/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/invokerrrr/autogame-python.svg?style=for-the-badge
[forks-url]: https://github.com/invokerrrr/autogame-python/network/members
[stars-shield]: https://img.shields.io/github/stars/invokerrrr/autogame-python.svg?style=for-the-badge
[stars-url]: https://github.com/invokerrrr/autogame-python/stargazers
[issues-shield]: https://img.shields.io/github/issues/invokerrrr/autogame-python.svg?style=for-the-badge
[issues-url]: https://github.com/invokerrrr/autogame-python/issues
[license-shield]: https://img.shields.io/github/license/invokerrrr/autogame-python.svg?style=for-the-badge
[license-url]: https://github.com/invokerrrr/autogame-python/blob/main/LICENSE