Skip to content

Vvamp/ImageRenderer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

 
 
 

Contributors

Languages