README

HXE KERNEL
==========

This tree contains the source code & documentation for HXE, a versatile
loader for SPV3 and wrapper for HCE.

FEATURES
--------

Here are some of the main features the kernel provides:

-   Wrapper around the HCE executable
-   Compatibility with HCE arguments (-window, -vidmode, etc.)
-   Automatic video/audio enhancements
    -   Custom native video resolution
    -   Border-less HCE window mode
-   Support for the SPV3 mod
    -   SPV3.2 loading, updating, installing
    -   SPV3.2/Lumoria campaign resuming
    -   SPV3.2 post-processing tweaking
    -   Backwards compatibility with SPV3.1
        -   Campaign resume
        -   Maps unlocking
-   Automatic profile detection

USAGE
-----

The USAGE document goes into detail on how to use HXE. In a nutshell:

    # automatically loads SPV3 in 720p window
    .\hxe.exe -window -vidmode 1280,720,60

    # installs SPV3 to C:\SPV3
    .\hxe.exe -install "C:\SPV3"

    # configure the kernel
    .\hxe.exe -config

SOURCE
------

The SPV3 repository contains the official HXE kernel source code, under
the hxe tree:

    https://source.n2.network/spv3/tree/hxe

LICENCE
-------

zlib License

Copyright (c) 2019 Emilian Roman

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1.  The origin of this software must not be misrepresented; you must not
    claim that you wrote the original software. If you use this software
    in a product, an acknowledgment in the product documentation would
    be appreciated but is not required.
2.  Altered source versions must be plainly marked as such, and must not
    be misrepresented as being the original software.
3.  This notice may not be removed or altered from any source
    distribution.