Skip to content

Commit

Permalink
docs: Update readme with new information
Browse files Browse the repository at this point in the history
  • Loading branch information
GittyMac committed Jan 28, 2024
1 parent 6a326a1 commit 8f5320d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<img align="left" width="100" height="100" src="https://i.imgur.com/BQZAfOc.png">

# FunkeySelectorGUI
A GUI for the Funkeys Selection Mod.
A GUI that lets you change Funkeys in the game U.B. Funkeys.

![FunkeySelectorGUI](https://i.imgur.com/vfNOFlA.png)

## Installation
To install FunkeySelectorGUI, put the FunkeySelector.exe file in the RadicaGame folder of your U.B. Funkeys installation.
It has to be in the RadicaGame folder to be able to write its customF.txt file.
Installing FunkeySelectorGUI depends on the executable you are using.
### OpenFK
To use FunkeySelectorGUI with OpenFK, simply place the executable in the RadicaGame directory. You will need to open FunkeySelectorGUI alongside OpenFK at the moment. OpenFK's customF mode supports FunkeySelectorGUI well.
### UBFunkeys.exe
To use FunkeySelectorGUI with the original UBFunkeys.exe, rename the FunkeySelectorGUI.exe to MegaByte.exe and place it into the MegaByte folder. When you launch U.B. Funkeys, FunkeySelectorGUI will open along with it.

## Build
You can use Visual Studio or any other IDEs that can compile dotNET 4.0 .sln files to compile FunkeySelectorGUI.
FunkeySelectorGUI uses Microsoft dotNET 4.0 due to its Windows XP support.

## Development Updates
If you want to see the progress of a FunkeySelectorGUI update, check the [projects page](https://github.com/GittyMac/FunkeySelectorGUI/projects) to see what's in progress, complete, and what's going to be implemented! Be sure to check the releases page to see if there's any alpha builds to test out! If you find any issues, be sure to submit an issue to let me know, it helps a lot!
FunkeySelectorGUI uses Microsoft dotNET 4.0 due to its Windows XP support.

0 comments on commit 8f5320d

Please sign in to comment.