Skip to content

Commit

Permalink
readme, deps
Browse files Browse the repository at this point in the history
  • Loading branch information
KraXen72 committed Jan 28, 2024
1 parent a429160 commit aad78de
Show file tree
Hide file tree
Showing 3 changed files with 529 additions and 805 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@

> a fast, feature-rich krunker client written in typescript
**Notice:**
crankshaft is **not** archived/unmaintained - the latest release works fine
development of new features **has been paused** due to a lack of time and the state krunker is in, but bugs will be fixed.
this is **not forever** - there will likely **be updates in the future**.

**Download:** [Windows (x64)](https://github.com/KraXen72/crankshaft/releases/latest/download/crankshaft-setup-win-x64.exe) - [Mac (x64)](https://github.com/KraXen72/crankshaft/releases/latest/download/crankshaft-portable-mac-x64.dmg) - [Linux (x86_64 AppImage)](https://github.com/KraXen72/crankshaft/releases/latest/download/crankshaft-portable-linux-x86_64.AppImage) - [Linux (i386 AppImage)](https://github.com/KraXen72/crankshaft/releases/latest/download/crankshaft-portable-linux-i386.AppImage) - [Other](https://github.com/KraXen72/crankshaft/releases/latest)
![splash](assets/blank_splash.png)


## upcoming breaking change
- **from version `1.9.0`, crankshaft will no longer support `Documents/Crankshaft` for configuration.**
- **make a backup of `Documents/Crankshaft` before updating.**
- **crankshaft 1.9.0 will auto-migrate the folder** to the new location in `%APPDATA%`, but there's a *very small chance* it could fail while moving/copying/deleting the files, and you'd lose your settings, swapper & scripts.
- this is due to inconsistent read/write permissions for users whose Documents directory lives inside of OneDrive or has been otherwise moved.
- crankshaft 1.9.0 will add quick-open buttons for the new directories & files for easy access.

![splash](assets/blank_splash.png)

## client features
- very good performance with additional performance enhancing settings
- highly customisable, many different settings
Expand All @@ -23,7 +26,7 @@ this is **not forever** - there will likely **be updates in the future**.
- quick class switcher using `#hiddenClasses`
- built-in hotkeys: [more about them here](#hotkeys)
- maintained & open source

## quality of life
- all client specific **features can be turned off** to ensure **maximum performance**
- once a feature is disabled, none of it code runs
Expand Down Expand Up @@ -66,13 +69,6 @@ standard hotkeys like zooming, copying/pasting and devtools also included.
a customisable matchmaker (with GUI settings!) that you can use alongside/instead of the regular `F6`
![matchmaker](./assets/matchmaker_screenshot.png)

## upcoming breaking change
- **from version `1.9.0`, crankshaft will no longer support `Documents/Crankshaft` for configuration.**
- **make a backup of `Documents/Crankshaft` before updating.**
- **crankshaft 1.9.0 will auto-migrate the folder**, but there's a *very small chance* it could fail while moving/copying/deleting the files, and you'd lose your settings, swapper & scripts.
- this is due to inconsistent read/write permissions for users whose Documents directory lives inside of OneDrive or has been otherwise moved.
- crankshaft 1.9.0 will add quick-open buttons for the new directories & files, as they are harder to access.

## building from source
1. **you have to have [git](https://git-scm.com/downloads), [nodejs](https://nodejs.org/en/download/), and [pnpm](https://pnpm.io/installation) installed**.
2. **installation**:
Expand Down
15 changes: 8 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,21 @@
"url": "https://github.com/KraXen72/crankshaft.git"
},
"devDependencies": {
"concurrently": "^8.2.0",
"conventional-changelog-cli": "^3.0.0",
"concurrently": "^8.2.2",
"conventional-changelog-cli": "^4.1.0",
"electron": "10.4.7",
"electron-builder": "23.6.0",
"esbuild": "^0.18.20",
"eslint": "^8.47.0",
"esbuild": "^0.20.0",
"eslint": "^8.56.0",
"eslint-config-airbnb-typescript": "^17.1.0",
"eslint-config-raven": "^1.0.3",
"eslint-plugin-import": "^2.28.0",
"typescript": "^5.1.6"
"eslint-plugin-import": "^2.29.1",
"typescript": "^5.3.3"
},
"dependencies": {
"@cliqz/adblocker-electron": "^1.26.15",
"compare-versions": "^6.1.0",
"dayjs": "^1.11.9",
"dayjs": "^1.11.10",
"discord-rpc": "^4.0.1",
"userscript-meta": "^1.0.1"
}
Expand Down
Loading

0 comments on commit aad78de

Please sign in to comment.