Nothing Special   »   [go: up one dir, main page]

Skip to content

lexisother/frenyard

Repository files navigation

Frenyard

A GUI library for Golang originally built for CCUpdaterUI (a mod manager for CrossCode), and now separated out into a separate repo.

Getting Started

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest files from the master branch.

go get github.com/lexisother/frenyard

Usage

Import the package into your project.

import "github.com/lexisother/frenyard"

See Documentation and Examples below for more detailed information.

Documentation

NOTICE: This library can be rather confusing. Because of that it may be difficult to get into using the library.

The code is fairly well documented at this point and is currently the only documentation available. Go reference (below) presents that information in a nice format.

  • Go Reference
  • Hand crafted documentation coming eventually.

Environment variables

Frenyard looks for certain environment variables as input to some internal functions.

FRENYARD_SCALE

A float that directly decides the scale of the window, no calculation is done.

FRENYARD_EXPR_MACOS_FIX

Enables some experimental fixes regarding scaling bugs on macOS. Can be used in tandem with FRENYARD_SCALE to debug said scaling issues.

Examples

Below is a list of examples and other projects using Frenyard. Please submit an issue if you would like your project added or removed from this list.

  • Frenyard Examples - A collection of example programs written using Frenyard
  • Cumcord Installer - Installer for Cumcord, a discontinued and no-longer-functioning modification for Discord.
  • Replugged Installer - Installer for Replugged, a functioning modification for Discord.
  • GitFren - A program that was supposed to be a local frontend for Gitea.
  • CCUpdaterUI - A mod manager and modloader installer for the video game CrossCode.

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue describing the bug or enhancement so it can be discussed.
  • Try to match current naming conventions as closely as possible.
  • Create a Pull Request with your changes against the master branch.