FXclient-mirror/readme.md

56 lines
2.6 KiB
Markdown
Raw Normal View History

<p align="center">
2024-03-28 11:30:31 -07:00
<a href="https://fxclient.github.io/FXclient/">
2024-02-04 11:59:12 -08:00
<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">
2024-02-04 11:59:12 -08:00
<img src="/assets/logo_text_light.png" width="20%">
</picture>
</a>
</p>
2024-02-08 11:04:45 -08:00
<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>
2024-03-28 11:32:09 -07:00
<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>
2024-02-08 11:04:45 -08:00
</p>
2023-01-24 11:43:05 -08:00
2022-12-23 00:15:24 -08:00
## What is FX Client?
2022-12-25 08:25:12 -08:00
FX Client is the first Territorial.io client, targeting better User Interface and better User Experience, It's basically Territorial.io but better.
2022-12-23 03:36:14 -08:00
2024-03-28 11:32:09 -07:00
**You can use the latest version of the client here: https://fxclient.github.io/FXclient/**
2024-03-05 13:09:33 -08:00
2024-02-25 07:40:21 -08:00
## Features:
2022-12-23 10:36:16 -08:00
1. It's 100% free and open source on Github
2024-05-20 11:24:29 -07:00
2. It's ad-free and removes game's default ads.
3. It makes game look cooler, by replacing default assets with new ones.
2024-03-08 07:49:52 -08:00
4. Displays your troop density and maximum troops
5. Displays the density of players and bots
2024-05-20 11:24:29 -07:00
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
2024-03-05 13:09:33 -08:00
#### The client has a settings menu, from which you can:
2024-05-20 11:24:29 -07:00
12. Make fullscreen mode trigger automatically
13. Set a custom main menu background
14. Create custom attack percentage keybinds
2024-03-05 13:09:33 -08:00
## Building Locally
To build the client locally, install Node.js if you haven't already, clone the repo, then run:
2024-02-22 23:06:03 -08:00
2024-03-05 13:09:33 -08:00
```
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`.
2024-02-22 23:06:03 -08:00
2024-02-25 07:40:21 -08:00
## Contact Us
2024-01-31 11:07:22 -08:00
2024-03-05 13:09:33 -08:00
Join the FX Client Discord server: https://discord.gg/JEwYWGraj7