Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NotNotWrongUsually/OutConsolePicture
Powershell cmdlet for rendering image files to console
https://github.com/NotNotWrongUsually/OutConsolePicture
Last synced: 5 days ago
JSON representation
Powershell cmdlet for rendering image files to console
- Host: GitHub
- URL: https://github.com/NotNotWrongUsually/OutConsolePicture
- Owner: NotNotWrongUsually
- Created: 2019-03-14T10:18:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T20:11:07.000Z (over 1 year ago)
- Last Synced: 2024-08-02T17:37:09.013Z (3 months ago)
- Language: PowerShell
- Size: 23.4 KB
- Stars: 30
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OutConsolePicture
Powershell cmdlet for rendering image files to console
# How to install?
The module is published to the Powershell Gallery, so get it from there with `Install-Module -Name OutConsolePicture`
# Result
# Documentation
Straight from the module help:
```
NAME
Out-ConsolePicture
SYNOPSIS
Renders an image to the console
SYNTAX
Out-ConsolePicture [-Path] [-Width ] [-TransparencyColor ] [-HorizontalPosition ] [-DoNotResize] []
Out-ConsolePicture -Url [-Width ] [-TransparencyColor ] [-HorizontalPosition ] [-DoNotResize] []
Out-ConsolePicture -InputObject [-Width ] [-TransparencyColor ] [-HorizontalPosition ] [-DoNotResize] []
DESCRIPTION
Out-ConsolePicture will take an image file and convert it to a text string. Colors will be "encoded" using ANSI escape strings. The final result will be output in the shell. By
default images will be reformatted to the size of the current shell, though this behaviour can be suppressed with the -DoNotResize switch. ISE users, take note: ISE does not report
a window width, and scaling fails as a result. I don't think there is anything I can do about that, so either use the -DoNotResize switch, or don't use ISE.
PARAMETERS
-Path
One or more paths to the image(s) to be rendered to the console.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Url
One or more Urls for the image(s) to be rendered to the console.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InputObject
A Bitmap object that will be rendered to the console.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Width
Renders the image at this specific width. Use of the width parameter overrides DoNotResize.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TransparencyColor
If the image is transparent this is the color that will be used for transparency. The parameter needs a color object. Check examples for how to set it. This should be the same
color as your console background usually.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HorizontalPosition
Takes the values "Left", "Center", or "Right" and renders the image in that position.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DoNotResize []
By default, images will be resized to have their width match the current console width. Setting this switch disables that behaviour.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
One or more System.Drawing.Bitmap objects
OUTPUTS
Gloriously coloured console output
-------------------------- EXAMPLE 1 --------------------------
PS > Out-ConsolePicture ".\someimage.jpg"
Renders the image to console
-------------------------- EXAMPLE 2 --------------------------
PS > Out-ConsolePicture -Url "http://somewhere.com/image.jpg"
Renders the image to console
-------------------------- EXAMPLE 3 --------------------------
PS > $image = New-Object System.Drawing.Bitmap -ArgumentList "C:\myimages\image.png"
$image | Out-ConsolePicture
Creates a new Bitmap object from a file on disk renders it to the console
-------------------------- EXAMPLE 4 --------------------------
PS > Out-ConsolePicture ".\someimage.jpg" -TransparencyColor ([System.Drawing.Color]::FromArgb(40, 44, 52))
Renders a transparent image using the specified color for transparency.
RELATED LINKS
```
# License
You can copy it, change it, or stick it in your hat;
But never charge a penny for it - simple as that!