Olve.OpenRaster 0.1.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package Olve.OpenRaster --version 0.1.1

NuGet\Install-Package Olve.OpenRaster -Version 0.1.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Olve.OpenRaster" Version="0.1.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Olve.OpenRaster" Version="0.1.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Olve.OpenRaster" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Olve.OpenRaster --version 0.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Olve.OpenRaster, 0.1.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#addin nuget:?package=Olve.OpenRaster&version=0.1.1
                    

                            Install Olve.OpenRaster as a Cake Addin

#tool nuget:?package=Olve.OpenRaster&version=0.1.1
                    

                            Install Olve.OpenRaster as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Olve.OpenRaster

LOC NuGet Downloads

The purpose of this library is to provide simple read-only access to .ora, or OpenRaster, files, with a simple native C# library with minimal dependencies, in fact, Olve.Utilities and OneOf are the only dependencies of this project.

Installation

Simply run the following command to add a dependency for the nuget package to your project:

dotnet add package Olve.OpenRaster

Usage

This package only contains two operations:

ReadOpenRasterFile opens a .ora file, reads the metadata from mimetype and stack.xml files and returns the data in an easily-consumable class structure.
GetLayerImage takes a layer image source string and reads the image with a provided IImageFileReader.

Currently, no default implementations of IImageFileReader have been added to the library, you will have to convert the byte stream to an image file yourself, but the .ora structure is handily abstracted away, so you will most likely only need to parse a .png file yourself.

The BigGustave library is a good candidate for this, as it is a simple and lightweight PNG decoder. Here is an example of how you could implement this:

dotnet add package BigGustave

using BigGustave;
using Olve.Utilities.Types.Results;

namespace Olve.OpenRaster.BigGustave;

public class PngFileReader : IImageFileReader<Png>
{
    public Result<Png> ReadImage(Stream stream)
    {
        return Png.Open(stream);
    }
}

Future

I want to expand this in the future with:

Reading all content. Currently, the following is not supported:
- Thumbnail images
- Merged image
Writing operations to both stack and all images.

Product	Compatible and additional computed target framework versions.
.NET	net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Olve.Utilities (>= 0.10.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.1.5	294	24 days ago
0.1.4	67	a month ago
0.1.3	58	a month ago
0.1.2	61	a month ago
0.1.1	99	a month ago
0.1.0	94	a month ago