Vvamp/ImageRenderer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Simple script that can generate JPEG images from raw RGB data
47 commits 8 branches 0 tags 256 KiB
  • Python 100%
Find a file
Exact
Vincent van Setten 881a6fb173
 Create FUNDING.yml
2021-04-21 22:41:37 +02:00
.github Create FUNDING.yml 2021-04-21 22:41:37 +02:00
tests Added test folder 2020-06-16 11:59:57 +02:00
.travis.yml updated path in travis.yml 2020-06-16 12:04:36 +02:00
LICENSE Create LICENSE 2020-06-12 21:49:17 +02:00
metadata.txt dded metadata.txt 2020-06-16 14:56:59 +02:00
README.md Fixed link in readme 2021-02-04 04:30:22 +01:00
render.py Added old changes back 2020-06-16 13:05:04 +02:00
requirements.txt added a requirements.txt 2020-06-16 11:22:02 +02:00

README.md

Contributors Badge Forks Badge Stars Badge Issues Badge License Badge Build Status

Image Renderer

A simple script that can render raw RGB data into a JPEG image.

Table of Contents

Getting Started

Prerequisites

  1. Python
  2. Python Pip

Installation

  1. Clone this project somewhere you like
    • git clone https://github.com/Vvamp/ImageRenderer
  2. Cd into the project directory
    • cd ImageRenderer
  3. Install the required modules
    • pip install -r requirements.txt

Usage

Automatic Options

Simple run python render.py in a terminal opened from the folder you cloned to.
This will run you through the required options.

Command Line Arguments

There are a lot of command line arguments you can pass. For example: python render.py -h shows all the available command line arguments and their usage.
The command python render.py -o my_image.jpg exports the rendered image into a file name 'my_image.jpg'.

See python render.py -h for a list of commands

Tests

You can test the code by running python render.py --path tests/test.txt -o tests/test.jpg --findx --findy -q.
This should generate an image file within the tests folder called 'test.jpg' and should look identical to the 'test-target.jpg'.

Test Image

test-target.jpg
test-target.jpg

Contributing

  1. Fork the project
  2. Create a feature branch: git checkout -b feature/<FeatureName>
  3. Make your changes
  4. Commit your changes: git commit -m "<Describe your changes"
  5. Push to the branch: git push origin feature/<FeatureName>
  6. Open a pull request

License

Distributed under the GNU General Public License V3.
See LICENSE for more details.

Contact

Vincent van Setten - @Vvamp - school@vincentvansetten.com
Project: Image Renderer

Acknowledgements