From dcaa02f29f6dbdc33c26952f70285a4cf5f01ea8 Mon Sep 17 00:00:00 2001 From: Lako Date: Wed, 24 Jul 2024 01:11:26 -0400 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++----------------------------- 1 file changed, 9 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 1e3259f..cadc189 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,21 @@ -![OpenFK Logo](https://github.com/GittyMac/OpenFK/blob/gh-pages/logo.png?raw=true) +OpenFK Logo # OpenFK #### An open source replacement for the U.B. Funkeys executable. -OpenFK adds new features while doing the same functions as the executable. - -### What does OpenFK do currently? -| Functional | -| ------------ | -| File loading via XMLs | -| Saving files | -| Fullscreen and Windowed mode | -| Basic online functionality | -| Mod support | -| Closing the game | -| Native RDF loading | -| USB connectivity | -| ActionScript 3 Elements | -| Checking updates | +OpenFK aims to enable the game to be played without having Adobe Flash Player installed, making it easier to play on modern operating systems. ### Installing OpenFK -OpenFK requires some manual work to set it up fully. +To install OpenFK, you need an existing installation of the U.B. Funkeys game along with .NET Framework 4.5. After downloading the ZIP file, simply extract the contents into the RadicaGame folder of your U.B. Funkeys installation directory. When the extraction process has finished, simply run OpenFK instead of UBFunkeys.exe to play. -Put the contents of the OpenFK release into your RadicaGame folder. +### Compatiblity +OpenFK supports all versions of U.B. Funkeys. Versions that utilize RDFv2 are fully supported as a drop-in replacement. Older versions that utilize the original RDFv1 format require a manual conversion of the RDF files. To achieve this, run the original UBFunkeys.exe with the -debug argument. This will create a log file that includes the RDF data of all the files loaded inside of it. Very old versions of the game also use a different way of creating users, which OpenFK tries to implement. This however can cuase issues, which may require manual intervention. -You will also need to find the Flash.ocx file, OpenFK will prompt you to download a compatible version if you don't have one. If it doesn't prompt you, you can [download and use the FetchOCX.bat utility.](https://github.com/GittyMac/OpenFK/releases/download/v1.5/FetchOCX.bat) +### Linux/Mac Port +OpenFK is heavily tied to ActiveX due to it having one of the only working versions of Adobe Flash Player that has support for isolating the plugin, processing FSCommands, and the SetVar command. This means that OpenFK will only be made for Windows, however the x86 version works flawlessly on Wine with the Adobe Flash Player 10 OCX. -Be sure to run the 'Configure OpenFK.bat' file to choose from some choices! - -### How to use USB support. -**To use USB support, you will need to have the MegaByte drivers installed.** - -Enable USB Support in the OpenFK configuration. - -Now you can use USB with OpenFK! (customF and USB can work together!) - -Please note USB support currently uses a workaround which can sometimes not work correctly. +### Issues beware! +OpenFK has been made to closely mimic the original UBFunkeys.exe, reaching near feature parity since v1.5. However, due to the way OpenFK was made, it can still have issues that only occur with OpenFK. These primarily occur in areas that have not been fully implemented and tested. These include the Paradox Green minigames and network connectivity. If you can find replicable errors with OpenFK, make sure to place an issue. ### Building OpenFK You can build OpenFK with anything that can build dotNET 4.5 projects, like Visual Studio. You also need to have the ActiveX version of Adobe Flash Player installed to be able to use the 'Shockwave Flash Object' COM component.