Skip to content

SceneGate/Hinox

Repository files navigation

Hinox

Stable version   GitHub commits since latest release (by SemVer)   Build and release   MIT License  

Hinox is a library part of the SceneGate framework that provides support for PS1 (PSX) file formats.

Supported formats

🚧 Project in an early development phase. No formats are supported yet.

Usage

The project provides the following .NET libraries (NuGet packages in nuget.org). The libraries work on supported versions of .NET.

  • SceneGate.Hinox 🚧 not ready yet
    • SceneGate.Hinox.Audio: audio codecs.

Preview releases can be found in this Azure DevOps package repository. To use a preview release, create a file nuget.config in the same directory of your solution file (.sln) with the following content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear/>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    <add key="SceneGate-Preview" value="https://pkgs.dev.azure.com/SceneGate/SceneGate/_packaging/SceneGate-Preview/nuget/v3/index.json" />
  </packageSources>
  <packageSourceMapping>
    <packageSource key="nuget.org">
      <package pattern="*" />
    </packageSource>
    <packageSource key="SceneGate-Preview">
      <package pattern="SceneGate.Hinox*" />
    </packageSource>
  </packageSourceMapping>
</configuration>

Documentation

Documentation is not yet available, but it will be published in the project website.

Don't hesitate to ask questions in the project Discussion site!

Build

The project requires .NET 9.0 SDK to build.

To build, test and generate artifacts run:

# Build and run tests
dotnet run --project build/orchestrator

# (Optional) Create bundles (nuget, zips, docs)
dotnet run --project build/orchestrator -- --target=Bundle

To build the documentation only, run:

dotnet docfx docs/docfx.json --serve

Special thanks

The standard file formats were based on the amazing reverse engineering work of Martin Korth at PSX Spex.