Electron app to easily connect to FusionFall servers
Go to file
2024-07-15 01:12:35 +01:00
.github/workflows chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
.vscode chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
assets chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
build Bump copyright date to 2024 and version to 1.5.2; update build.yml 2024-04-02 06:49:15 -05:00
cache_handler cleaned up and added docstrings to cache handler 2024-04-06 02:31:59 +03:00
defaults chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
lib cleaned up and added docstrings to cache handler 2024-04-06 02:31:59 +03:00
patches Move to npm for development and packaging 2021-04-28 12:37:22 -05:00
.editorconfig Move server-selector over to path.join(), fix issues with cache swapping 2023-09-19 08:57:29 -05:00
.gitattributes added linguist-vendored 2024-04-06 02:31:59 +03:00
.gitignore edited gitignore for extra files 2024-04-06 02:31:56 +03:00
.npmrc Move to npm for development and packaging 2021-04-28 12:37:22 -05:00
.prettierignore format assets but ignore minified files 2022-07-26 15:48:33 +01:00
.prettierrc switch from tabs to spaces & set indent size to 4 2022-07-26 15:41:07 +01:00
index.html chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
index.js chore: format files and enable format on save 2024-07-15 00:08:16 +01:00
LICENSE.md Bump copyright date 2024-02-02 19:01:07 -08:00
package-lock.json chore: Update package.json dependencies and description 2024-07-15 00:06:51 +01:00
package.json chore: Update package.json description to "OpenFusionClient" 2024-07-15 01:12:35 +01:00
README.md README: include preleases for release badge 2023-09-17 09:42:41 -05:00

OpenFusionClient

Current Release DiscordLicense

An Electron app that allows you to easily join FusionFall servers.

It automatically installs FF's custom build of Unity Web Player, manages text files such as assetInfo.php/loginInfo.php, and embeds the game, all in a few clicks!

For an overview of how the game client worked originally, please see this section in the OpenFusion README.

Disclaimer

This repository does not contain any code from the actual FusionFall game client. Think of it more as a launcher: it abstracts away having to use a NPAPI plugin capable web browser, along with having to host a HTTP server for it to connect to.

In addition, if you are interested in contributing: do note that this project likely cannot utilize more modern Javascript techniques. In order to use NPAPI plugins, a very old version of Electron was needed (0.31.0). This limits the project to only a portion of ES5 in non-strict mode, and a reduced subset of Node/Electron APIs.

Usage

Provided that you have npm installed, clone the repository, then run install like so:

git clone https://github.com/OpenFusionProject/OpenFusionClient.git
npm install

After that has completed you can then test OpenFusionClient:

npm run start

If you would like to package it as a standalone win32 application:

npm run pack

You can then compress the application directory into a zip file and installer for distribution:

npm run dist

Before opening a PR or running pack/dist, please do a code formatting pass:

npm run prettier

License

MIT unless specified otherwise