PyAGE

<!-- taken from Best-README-Template <!-- https://github.com/othneildrew/Best-README-Template <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!-- PROJECT LOGO --> <br /> <p align="center"> <h3 align="center">pyAGE</h3> <p align="center"> an audio game engine written in Python <br /> <a href="https://github.com/Timtam/pyage/issues">Report Bug</a> · <a href="https://github.com/Timtam/pyage/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

• About the Project
• Getting Started
• Roadmap
• Contributing
• License
• Contact

<!-- ABOUT THE PROJECT -->

About The Project

pyAGE is an audio game engine written in Python, striving to be an all-in-one library for developing audio-only games on several operating systems like Windows, Linux or Mac OS. With full Python 3 compatibility, including type-checking via MyPy, and extensibility in mind, it supports various screen readers and audio libraries and aims to be as flexible as possible.

<!-- GETTING STARTED -->

Getting Started

We offer a comprehensive documentation, including a full tutorial and API documentation. visit the documentation

<!-- ROADMAP -->

Roadmap

See the open issues for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

Contributing

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

Contribute by coding

1. Fork the 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

Contribute by testing

If you find any bugs or got some amazing idea to share or discuss, don't hesitate to open an issue and we'll see where we can go from there.

Contribute by paying me a coffee

Developing takes time and effort and since this project is free to use and open-source, I don't get anything out of it except appreciation. Appreciation doesn't pay monthly bills though. If you think this project greatly improved your life by helping you with your productivity and workflow, or you simply want to give something back, i'd greatly appreciate a small donation via PayPal to the following link: https://paypal.me/ToniRonaldBarth Don't feel obligated though.

<!-- LICENSE -->

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

<!-- CONTACT -->

Contact

Toni Barth - @GixGax95 - software@satoprogs.de

Project Link: https://github.com/Timtam/pyage

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->