Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmenon1008/mockupgen
Quickly generate a 3D device mockup from a screenshot
https://github.com/rmenon1008/mockupgen
Last synced: 3 months ago
JSON representation
Quickly generate a 3D device mockup from a screenshot
- Host: GitHub
- URL: https://github.com/rmenon1008/mockupgen
- Owner: rmenon1008
- License: mit
- Created: 2023-05-10T20:27:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-18T19:50:31.000Z (over 1 year ago)
- Last Synced: 2024-04-24T16:24:26.594Z (9 months ago)
- Language: Python
- Homepage: https://pypi.org/project/mockupgen/
- Size: 27.2 MB
- Stars: 53
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - rmenon1008/mockupgen - Quickly generate a 3D device mockup from a screenshot (Python)
README
# mockupgen
A tool that generates a 3D device mockup from a screenshot.
Read my post on [how it works](https://www.rohanmenon.com/projects/mockupgen/)!
# Installation
```
pip install mockupgen
```
Alternatively, from source:
```
git clone https://github.com/rmenon1008/mockupgen.git
cd mockupgen
pip install .
```
# Usage
```
mockupgen [OPTION...] screenshot_file
OPTION:
-t TEMPLATE template name or number
-o OUTFILE output file name (use extension to specify format)
-w WIDTH output width (will upscale if requested)
--crop crop instead of stretching the screenshot to fit the mockup
--rotate number of times to rotate the screenshot 90 degrees ccw
--brightness B screen brightness adjustment (default: 1.0)
--contrast C screen contrast adjustment (default: 1.0)
--list list available templates
--custom-templates PATH/URL specify a custom directory of templates (see README.md)
```
# Templates
The [`mockupgen-templates`](https://github.com/rmenon1008/mockupgen-templates) repository contains the default templates used by `mockupgen`. Most are based on the fabulous work of [Anthony Boyd](https://www.anthonyboyd.graphics/). You can see the available templates with `mockupgen --list`.
## Custom templates
Instead of using the default templates, you can supply your own by specifying `--custom-templates`. The directory or URL should contain an index.json file with the following format:
```jsonc
// index.json
// Note: All paths are relative to this file
{
"index_version": 1.0, // Version of the template index
"templates": [
{
// Required fields
"name": "Macbook Pro 16 Silver (Green Background)",
"slug": "mbp-16-silver-green", // Try to follow device-size-color-background format
"base_file": "base.png", // The device template image
"screen_points": [ // The pixel locations of the 4 corners of the screen
[896, 224], // Starts in the top left and goes counter clockwise
[896, 654],
[1471, 985],
[1471, 555]
],
// Only one of the two options below must be specified
"mask_file": "mask.png", // An image used to mask the screenshot (alpha channel used)
// OR
"mask_aspect_ratio": 1.0, // Aspect ratio to mask the screenshot (assumes rectangular)
// Optional fields
"black_white_point": ["292826", "D9DCDD"], // Black and white points
// for color correction
"brightness": 1.0, // Brightness adjustment of the screenshot
"contrast": 1.0 // Contrast adjustment of the screenshot
},
...
]
}
```
# About
Mockups typically require expensive and slow image processing tools to create. While these can create realistic mockups, they're very manual and usually overkill for the blog post thumbnail I'm trying to create.
The tool uses opencv to mask, warp and composite screenshots onto a template. Right now, it doesn't do any lighting or shadow effects.