aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 66965f55bc1aada14ecde4d09da14ab4f6112375 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# VexClient
A Hacked Client for Krunker.io.

## Why this Client?
- Many custom hacks.
- Many extra features available as well. You can also suggest features you want to improve the client.

## Features
- Every single features from official client is available (Resource Swapper, Unlimited FPS, etc.) 
---
- Performance
	- WORKING FPS limiter (you can still use the original FPS limiter by setting this to 0.)
- Patches
	- Added compatibility with custom fonts to few social and market pages. (optional)
	- Fixed "Clear Cache" button. (also faster)
	- Fixed a bug with the Discord RPC.
	- Fixed splash screen font size.
- General Tweaks
	- Allows you to chat with special characters like Japanese, Hangul, or 🤯emojis⌨️. (optional)
	- Remembers server search keywords. (optional)
	- Look for new server by pressing F6 key.
- Interface Tweaks
	- Adds a button that refresh the server browser.
	- Ability to hide various elements. (ads (you can still claim Free KR), merch, etc.)
	- Ability to use custom CSS file.
	- Customizable health display type.
	- Customizable offsets for various elements. (scope, game overlay, etc.)
	- Customizable opacity for various elements. (scope, crosshair, etc.)
	- Remove text shadows. (optional, useful for custom fonts)
- Splash Screen
	- Customizable background and fonts for splash screen.
- Client Tweaks
	- Added ability to change auto updater behavior from settings or `--update=<download|check|skip>` argument. (argument method temporary overrides config)
	- Added ability to disable Discord RPC. (optional)
	- Added ability to disable Resource Swapper. (optional)
	- Added a button that opens `appData` directory.
	- Added a button that relaunch the client.
	- Auto updater support with GitHub - When there is a new client release, the auto updater automatically installs it.
	- Export current game state to a file - Can be used for some Twitch bot that reads local file, etc.
	- Relanch the client by pressing `Alt + Ctrl + Shift + R` keys.
- Network
	- Ability to dump network resources. (useful for making mods and customizations / may reduce performance / optional / disable Resource Swapper if you want to dump all files since it prevents dumper from duming some files)
- Debugging
	- Added keyboard shortcut for toggle DevTools. (`Alt + Command + I` for Mac, `Ctrl + Shift + I` for other platforms)
	- Added ability to always enable debug mode. (optional)
	- Few minor tweaks for debugging.
---
- Options that added by the custom client is highlighted in orange.
- Some of options has to restart the client or reload the page to apply.

### Releases
Releases are prebuilt binaries, these are not always latest but one of the easiest way to get the client.  
You can download them from the [release page](https://github.com/8cy/VexClient/releases/latest).
- Windows:
	- `Custom-Krunker-Client-Setup-<version>.exe` - 32 & 64-bit installer
	- `Custom-Krunker-Client-<version>.exe` - 32 & 64-bit portable executable
- Linux:
	- `Custom-Krunker-Client-<version>.AppImage` - 64-bit portable executable
	- `Custom-Krunker-Client-<version>-i386.AppImage` - 32-bit portable executable

You don't have to download `.blockmap` or `.yml` files, because those files are released only for auto update purpose.