Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BluZed authored Mar 24, 2023
1 parent bfe87e9 commit aff219f
Showing 1 changed file with 42 additions and 2 deletions.
44 changes: 42 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,42 @@
# Radioactive-Krunker-Client is currently beta-only.
update- its currently getting reworked :D
# ☢️ Radioactive Krunker Client
[![Windows](https://svgshare.com/i/ZhY.svg)](https://svgshare.com/i/ZhY.svg) ![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)

_Radioactive krunker client is a new krunker client that is aimed towards providing features to the krunker players while also keeping performance as a priority._

## Features
Currently the features listed below are present.
- Uncapped FPS
- Alt Manager
- CSS Browser
- Plugins Browser
- Auto Update-Checking

## Installation
Prebuilt binaries are availaible for Windows. Any other OS user needs to build from source themselves.
- Open the [latest release page](/~https://github.com/BluZed/Radioactive-Krunker-Client/releases/latest)
- Download the setup `exe` file
- Open the downloaded setup file and go through the options.
## Support
All support/Bugs/Glitches are to be reported directly to me or in the [discord server](https://discord.gg/9fN49nTnfs).
> My Discord is `BluZed#0001`
## Building from source
- [Install NodeJS](https://nodejs.org/en)

- Download the source code as [a zip](/~https://github.com/BluZed/Radioactive-Krunker-Client/archive/refs/heads/main.zip) or using the github cli :-
`git clone BluZed/Radioactive-Krunker-Client`

- cd into the repository:
`cd Radioactive-Krunker-Client`

- Install all dependencies:
`npm i`

- Start/Test Client
`npm start`

- Build
`npm run dist`

## Credits
- This project is not possible without the [Electron framework](https://www.electronjs.org/)
- The start splash screen background images belong to the respective owners. Kindly check [this file]() to know more and if any of them wants to be removed, please [dm me](https://discord.gg/9fN49nTnfs) on discord and i'll remove it asap.

0 comments on commit aff219f

Please sign in to comment.