mirror of
https://github.com/OpenFusionProject/Client.git
synced 2024-11-22 13:40:06 +00:00
Compare commits
2 Commits
e19098a13e
...
7131026b2f
Author | SHA1 | Date | |
---|---|---|---|
|
7131026b2f | ||
7dd018e336 |
17
README.md
17
README.md
@ -1,45 +1,52 @@
|
|||||||
# OpenFusionClient
|
# OpenFusionClient
|
||||||
|
|
||||||
[![Current Release](https://img.shields.io/github/v/release/OpenFusionProject/OpenFusionClient)](https://github.com/OpenFusionProject/OpenFusionClient/releases/latest) [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/DYavckB)[![License](https://img.shields.io/github/license/OpenFusionProject/OpenFusionClient)](https://github.com/OpenFusionProject/OpenFusionClient/blob/master/LICENSE.md)
|
[![Current Release](https://img.shields.io/github/v/release/OpenFusionProject/OpenFusionClient)](https://github.com/OpenFusionProject/OpenFusionClient/releases/latest) [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/DYavckB)[![License](https://img.shields.io/github/license/OpenFusionProject/OpenFusionClient)](https://github.com/OpenFusionProject/OpenFusionClient/blob/master/LICENSE.md)
|
||||||
|
|
||||||
An Electron app that allows you to easily join FusionFall servers.
|
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!
|
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](https://github.com/OpenFusionProject/OpenFusion#architecture ).
|
For an overview of how the game client worked originally, please see [this section in the OpenFusion README](https://github.com/OpenFusionProject/OpenFusion#architecture).
|
||||||
|
|
||||||
## Disclaimer
|
## 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.
|
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.
|
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
|
## Usage
|
||||||
|
|
||||||
Provided that you have npm installed, clone the repository, then run install like so:
|
Provided that you have npm installed, clone the repository, then run install like so:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/OpenFusionProject/OpenFusionClient.git
|
git clone https://github.com/OpenFusionProject/OpenFusionClient.git
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
After that has completed you can then test OpenFusionClient:
|
After that has completed you can then test OpenFusionClient:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm run start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
If you would like to package it as a standalone win32 application:
|
If you would like to package it as a standalone win32 application:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm run pack
|
npm run pack
|
||||||
```
|
```
|
||||||
|
|
||||||
You can then compress the application directory into a zip file and installer for distribution:
|
You can then compress the application directory into a zip file and installer for distribution:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm run dist
|
npm run dist
|
||||||
```
|
```
|
||||||
|
|
||||||
Before opening a PR or running pack/dist, please do a code formatting pass:
|
Before opening a PR or running pack/dist, please do a code formatting pass:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm run prettier
|
npm run prettier
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT unless specified otherwise
|
MIT unless specified otherwise
|
||||||
|
12
assets/bootstrap/css/bootstrap.min.css
vendored
12
assets/bootstrap/css/bootstrap.min.css
vendored
File diff suppressed because one or more lines are too long
30
assets/css/bootstrap.min.css
vendored
Normal file
30
assets/css/bootstrap.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
assets/fonts/KFOlCnqEu92Fr1MmWUlvAw.ttf
Normal file
BIN
assets/fonts/KFOlCnqEu92Fr1MmWUlvAw.ttf
Normal file
Binary file not shown.
BIN
assets/fonts/KFOmCnqEu92Fr1Me5Q.ttf
Normal file
BIN
assets/fonts/KFOmCnqEu92Fr1Me5Q.ttf
Normal file
Binary file not shown.
@ -7,7 +7,7 @@
|
|||||||
content="width=device-width, initial-scale=1.0, shrink-to-fit=no"
|
content="width=device-width, initial-scale=1.0, shrink-to-fit=no"
|
||||||
/>
|
/>
|
||||||
<title>OpenFusion: Server Selector</title>
|
<title>OpenFusion: Server Selector</title>
|
||||||
<link rel="stylesheet" href="assets/bootstrap/css/bootstrap.min.css" />
|
<link rel="stylesheet" href="assets/css/bootstrap.min.css" />
|
||||||
<link rel="stylesheet" href="assets/fonts/fontawesome-all.min.css" />
|
<link rel="stylesheet" href="assets/fonts/fontawesome-all.min.css" />
|
||||||
<link rel="stylesheet" href="assets/css/openfusion.css" />
|
<link rel="stylesheet" href="assets/css/openfusion.css" />
|
||||||
<link rel="stylesheet" href="assets/css/styles.css" />
|
<link rel="stylesheet" href="assets/css/styles.css" />
|
||||||
@ -480,7 +480,7 @@
|
|||||||
src="assets/js/jquery.min.js"
|
src="assets/js/jquery.min.js"
|
||||||
onload="window.$ = window.jQuery = module.exports;"
|
onload="window.$ = window.jQuery = module.exports;"
|
||||||
></script>
|
></script>
|
||||||
<script src="assets/bootstrap/js/bootstrap.min.js"></script>
|
<script src="assets/js/bootstrap.min.js"></script>
|
||||||
<script src="assets/js/bs-init.js"></script>
|
<script src="assets/js/bs-init.js"></script>
|
||||||
<script src="assets/js/uuidv4.min.js"></script>
|
<script src="assets/js/uuidv4.min.js"></script>
|
||||||
<script src="assets/js/serverselector.js"></script>
|
<script src="assets/js/serverselector.js"></script>
|
||||||
|
Loading…
Reference in New Issue
Block a user