FXclient-mirror/readme.md

56 lines
2.6 KiB
Markdown

<p align="center">
<a href="https://fxclient.github.io/FXclient/">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="/assets/logo_text_dark.png">
<source media="(prefers-color-scheme: light)" srcset="/assets/logo_text_light.png">
<img src="/assets/logo_text_light.png" width="20%">
</picture>
</a>
</p>
<p align="center">
<a href="https://discord.gg/JEwYWGraj7"><img alt="FX Client Discord" src="https://img.shields.io/discord/1055801912286515220?logo=discord&logoColor=white&label=FX%20Client&color=5865F2"></a>
<a href="https://github.com/fxclient/FXclient/actions/workflows/deploy_github_pages.yml"><img src="https://github.com/fxclient/FXclient/actions/workflows/deploy_github_pages.yml/badge.svg" alt="Build and Publish to GitHub Pages"></a>
<a href="https://fxclient.github.io/FXclient/"><img src="https://github.com/fxclient/FXclient/actions/workflows/pages/pages-build-deployment/badge.svg" alt="pages-build-deployment"></a>
</p>
## What is FX Client?
FX Client is the first Territorial.io client, offering a better User Interface and better User Experience. It's basically Territorial.io but better.
**You can use the latest version of the client here: https://fxclient.github.io/FXclient/**
## Features:
1. It's 100% free and open source on Github
2. It's ad-free and removes game's default ads.
3. It makes game look cooler, by replacing default assets with new ones.
4. Displays your troop density and maximum troops
5. Displays the density of players and bots
6. Adds a "Clan" tab on the leaderboard, allowing you to easily see your clanmates
7. Hovering tooltip: makes the territory map information (normally visible on right click) be visible constantly (on hover)
8. Adds a player list
9. Adds the ability to view the history of who donated to a player during a team game by clicking on their name in the leaderboard or the player list
10. Adds a win counter
11. Can be installed as a PWA (progressive web app) ensuring maximum enjoyment on consoles, phones and even desktop devices
#### The client has a settings menu, from which you can:
12. Make fullscreen mode trigger automatically
13. Set a custom main menu background
14. Create custom attack percentage keybinds
## Building Locally
To build the client locally, install Node.js if you haven't already, clone the repo, then run:
```
npm install
npm run build
```
This will install the dependencies, download the game and build the client.
To build from an already downloaded copy of the game, use `npm run build-only`.
## Contact Us
Join the FX Client Discord server: https://discord.gg/JEwYWGraj7