OpenPunk
/
Client
mirror of https://github.com/OpenFusionProject/Client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Electron app to easily connect to FusionFall servers
80 Commits 1 Branch 8 Tags 52 MiB
HTML 47.2%
JavaScript 47.1%
CSS 5.7%
Go to file
CakeLancelot d4dc403e90 Remove now unnecessary attributes from game-client.js 2023-09-14 15:13:23 -05:00
.vscode switch from tabs to spaces & set indent size to 4 2022-07-26 15:41:07 +01:00
assets Remove now unnecessary attributes from game-client.js 2023-09-14 15:13:23 -05:00
build Use extra-plugin-dirs in Electron to load plugin, add fusion manifest. 2023-09-14 05:29:34 -05:00
defaults switch from tabs to spaces & set indent size to 4 2022-07-26 15:41:07 +01:00
patches Move to npm for development and packaging 2021-04-28 12:37:22 -05:00
.gitattributes Enforce LF in repo 2021-05-16 20:59:01 -05:00
.gitignore Add missing Unity Web Player files 2021-09-18 19:07:56 -04: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
LICENSE.md package.json tweaks, update LICENSE.md date 2023-02-09 01:04:20 +00:00
README.md Misc tweaks 2023-09-02 23:03:00 -05:00
index.html Use extra-plugin-dirs in Electron to load plugin, add fusion manifest. 2023-09-14 05:29:34 -05:00
index.js Use extra-plugin-dirs in Electron to load plugin, add fusion manifest. 2023-09-14 05:29:34 -05:00
initial-setup.html Consistency pass and small tweaks 2023-09-03 05:12:30 -05:00
package-lock.json Bump fs-extra version to 2.0.0 2023-02-17 20:07:52 -06:00
package.json Use extra-plugin-dirs in Electron to load plugin, add fusion manifest. 2023-09-14 05:29:34 -05:00

README.md

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