poy-ui-lib

A UI library for Peaks of Yore.

Overview

• Installing
• Building from source
  • Dotnet
  • Visual Studio
  • Build configuration
• Credits

Installing

BepInEx

If you haven't installed BepInEx yet, follow the install instructions here:

• Windows
• Linux

UILib

• Download the latest release here.
• The compressed zip will contain a plugins directory.
• Copy the files in plugins to BepInEx/plugins in your game directory.

Building from source

Whichever approach you use for building from source, the resulting plugin/mod can be found in bin/.

The following configurations are supported:

• Debug
• Release

Keep in mind, res/uilib.bundle is not pushed with the repo. So you would have to make your own.

Dotnet build

To build with dotnet, run the following command, replacing with the desired value:

dotnet build -c <configuration>

Visual Studio build

To build with Visual Studio, open UILib.sln and build by pressing ctrl + shift + b, or by selecting Build -> Build Solution.

Build configuration

The following can be configured:

• The path Peaks of Yore is installed at.
• Whether the mod should automatically install on build.
• Whether integration with Mod Menu should be enabled.

Note that all of these properties are optional.

The configuration file must be in the root of this repository and must be called Config.props.

<Project>
  <PropertyGroup>
    <!-- For example, if peaks is installed under F: -->
    <GamePath>F:\Games\Peaks of Yore</GamePath>

    <!-- Add this option if you want to install after building -->
    <InstallAfterBuild>true</InstallAfterBuild>

    <!-- Add this option if you want to disable mod menu integration
        This is useful for bootstrapping UILib -->
    <ModMenu>false</ModMenu>
  </PropertyGroup>
</Project>

Credits

• Roman Antique font: https://www.dafont.com/roman-antique.font
• Givo: fixing input field fonts, suggesting themes, suggesting toggling interactions with overlays/windows (like the steam overlay)
• Argore: suggesting bounds checks for window/component focus and shaders for generating the color picker graphics