gameart 0.1.25

Create printable art with the movement of your mouse.

GameArt

Create printable art with the movement of your mouse.
Explore the source code »

View Readme · Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. Enhancement
4. Contributing
5. License
6. Contact

Getting Started

GameArt is still work in progress. Currently it is possible to create a png-file with matplotlib from the recorded mouse movement using pynput. The "Art" aspect is currently missing, but I will work on that.

These package versions are available:

• gameart: This version is targeting the end user version with the possibility to record your mouse movement, save it as a csv and draw a png based on csv input.
• ameart[dev]: This version has additional dev packages to be able to contribute to this project.
• gameart[release]: This version has additional build packages to generate a package and upload to PyPi.

Prerequisites

• Supported python versions: Python 3.10, 3.11, 3.12
• Upgrade pip

  pip install --upgrade pip
  

• It is recommended to use the package inside a virtual environment.
  • Create virtual environment

  python -m venv env
  

  • Activate virtual environment - Linux

  source env/bin/activate
  

  • Activate virtual environment - Windows

  env/Scripts/activate
  

Installation

1. Executable:
   1. Download latest executable from here: https://github.com/AndManGames/GameArt/releases (Windows: gameart.exe; Linux: gameart)
2. From GitHub:
   1. Clone the repo

   git clone https://github.com/AndManGames/GameArt.git
   

   2. Install gameart packages from git root path

   pip install .
   

3. From PyPi:

pip install gameart

(back to top)

Usage

• If you have downloaded the executable:

  • Double click gameart executable file and the GUI will open.

• If you have cloned from github or installed from PyPi:

  • Start GUI from terminal/command line:

    gameart start_gui
    

  • Use command line interface (CLI):
    • Start recording of your mouse movement:

    gameart record
    

    • Generate image from your mouse recording:

    gameart draw --csv_file_path path/to/csv/file
    

• Hint: Stop the recording by pressing the Right Mouse Button

(back to top)

Enhancement

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

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

For contributing please use the dev setup of this package:

pip install .[dev]

(back to top)

License

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

(back to top)

Contact

Andreas Schneider - [e-mail]

Project Link: https://github.com/AndManGames/GameArt

(back to top)