bigjakk/Krunker-Civilian-Client-Test
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

docs: fix heading capitalization
Build and Release / build-and-release (push) Failing after 1m23s
Details

Browse Source
This commit is contained in:
bigjakk
2026-04-03 15:38:56 -07:00
parent f050ef3b81
commit 40bdd1bf69
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -6,7 +6,7 @@
[Windows (x64)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest) - [Windows (x64)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest) -
[Linux (AppImage)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest) [Linux (AppImage)](https://gitea.crjlab.net/bigjakk/Krunker-Civilian-Client/releases/latest)
## features ## Features
- unlimited FPS with no aim freeze (custom Electron build, see [below](#custom-electron-build)) - unlimited FPS with no aim freeze (custom Electron build, see [below](#custom-electron-build))
- unobtrusive — all features can be disabled, no watermarks - unobtrusive — all features can be disabled, no watermarks
@@ -37,7 +37,7 @@
- auto-updater - auto-updater
- maintained & open source - maintained & open source
## hotkeys ## Hotkeys
All hotkeys are rebindable in settings. All hotkeys are rebindable in settings.
@@ -58,19 +58,19 @@ All hotkeys are rebindable in settings.
| `Ctrl+Shift+T` | Reopen closed tab | | `Ctrl+Shift+T` | Reopen closed tab |
| `Ctrl+1-9` | Jump to tab | | `Ctrl+1-9` | Jump to tab |
## userscripts ## Userscripts
Any `.js` file in the scripts folder will be loaded as a userscript if enabled in settings. Scripts support Tampermonkey-style metadata blocks (`@name`, `@author`, `@version`, `@desc`) and can define custom settings (boolean, number, select, color, keybind). Any `.js` file in the scripts folder will be loaded as a userscript if enabled in settings. Scripts support Tampermonkey-style metadata blocks (`@name`, `@author`, `@version`, `@desc`) and can define custom settings (boolean, number, select, color, keybind).
> **Use userscripts at your own risk.** Do not write or use any userscripts which would give you a competitive advantage. > **Use userscripts at your own risk.** Do not write or use any userscripts which would give you a competitive advantage.
## custom Electron build ## Custom Electron Build
This client uses a custom-patched Electron 42 build to overcome the aim freezing issue present in modern Electron versions. The patched binary is downloaded automatically during `npm install`. This client uses a custom-patched Electron 42 build to overcome the aim freezing issue present in modern Electron versions. The patched binary is downloaded automatically during `npm install`.
For details on the patch and build instructions, see [Electron-Websocket-Fix](https://github.com/bigjakk/Electron-Websocket-Fix). For details on the patch and build instructions, see [Electron-Websocket-Fix](https://github.com/bigjakk/Electron-Websocket-Fix).
## building from source ## Building From Source
1. Install [git](https://git-scm.com/downloads), [Node.js](https://nodejs.org/), and npm 1. Install [git](https://git-scm.com/downloads), [Node.js](https://nodejs.org/), and npm
2. Clone and install: 2. Clone and install:
@@ -82,7 +82,7 @@ For details on the patch and build instructions, see [Electron-Websocket-Fix](ht
3. Run: `npm start` or `npm run dev` (dev mode with sourcemaps) 3. Run: `npm start` or `npm run dev` (dev mode with sourcemaps)
4. Package: `npm run dist:win` or `npm run dist:linux` 4. Package: `npm run dist:win` or `npm run dist:linux`
## credits ## Credits
- Built on ideas from [Crankshaft](https://github.com/KraXen72/crankshaft) by KraXen72 - Built on ideas from [Crankshaft](https://github.com/KraXen72/crankshaft) by KraXen72
- Inspired by [Glorp](https://github.com/slavcp/glorp) by slav - Inspired by [Glorp](https://github.com/slavcp/glorp) by slav