Skip to main content

Create printable art with the movement of your mouse.

Project description

Contributors Forks Stargazers Issues MIT License


Logo

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
  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.

There are 2 package versions 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.
  • gameart[dev]: This version has additional dev packages to be able to contribute to this project.

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. From GitHub:
    1. Clone the repo
    git clone https://github.com/AndManGames/GameArt.git
    
    1. Install gameart packages from git root path
    pip install .
    
  2. From PyPi:
pip install gameart

(back to top)

Usage

  • GUI

    • Start GUI
    gameart start_gui
    
  • 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 - programmerhumor22@gmail.com

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

(back to top)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gameart-0.1.15.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

gameart-0.1.15-py3-none-any.whl (12.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page