OpenPunk/Client
1
0
Fork 0
mirror of https://github.com/OpenFusionProject/Client.git synced 2024-11-13 02:10:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Electron app to easily connect to FusionFall servers
89 Commits 1 Branch 9 Tags 55 MiB
JavaScript 35.5%
HTML 32.7%
Python 28.9%
CSS 2.9%
cef8c1de93
Go to file
CakeLancelot cef8c1de93 Revert readJsonSync() change for modifying servers 
readJsonSync() apparently produces an immutable JSON, which made it to where you couldn't add or remove servers
2023-10-18 12:47:41 -05:00
.vscode switch from tabs to spaces & set indent size to 4 2022-07-26 15:41:07 +01:00
assets Revert readJsonSync() change for modifying servers 2023-10-18 12:47:41 -05:00
build Disable telemetry in player dll 2023-09-19 08:59:13 -05:00
defaults Update version numbers to 1.5 2023-10-07 18:20:10 -05: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 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
index.html Use extra-plugin-dirs in Electron to load plugin, add fusion manifest. 2023-09-14 05:29:34 -05:00
index.js Misc comment cleanup, correct holiday date range, simplify JSON loading 2023-09-19 08:57:50 -05:00
LICENSE.md package.json tweaks, update LICENSE.md date 2023-02-09 01:04:20 +00:00
package-lock.json Update version numbers to 1.5 2023-10-07 18:20:10 -05:00
package.json Update version numbers to 1.5 2023-10-07 18:20:10 -05:00
README.md README: include preleases for release badge 2023-09-17 09:42:41 -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