mirror of
https://github.com/JonnyBro/beatrun.git
synced 2024-12-28 12:53:02 +05:00
110 lines
4.9 KiB
Markdown
110 lines
4.9 KiB
Markdown
# Beatrun | Community edition
|
|
|
|
[](https://forthebadge.com)
|
|
[](https://forthebadge.com)
|
|
|
|
[Click to join our Discord!](https://discord.gg/93Psubbgsg)
|
|
|
|
* [Русский](./README.ru.md)
|
|
|
|
**PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS!**
|
|
|
|
Infamous parkour addon for Garry's Mod. Fully open sourced and maintained by the community (me 😞).
|
|
|
|
> [!IMPORTANT]
|
|
> This repository doesn't contain any malicious modules. However, we have some modules for additional functionality:
|
|
>
|
|
> * Discord Rich Presence.
|
|
> * Steam Presence.
|
|
>
|
|
> **They are completely optional and can be removed at any time.**\
|
|
> You can find all modules **[here](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
|
|
> Check **[Credits](#credits)** section for their source code.
|
|
|
|
## Automatic Installation (Recommended | Windows 10/11)
|
|
|
|
> [!WARNING]
|
|
> Windows 7 and old versions of Windows 10 are not supported.\
|
|
> Please update.
|
|
|
|
Run the command below in Powershell (run as admin if your Steam or game located in a C: drive).
|
|
> [!NOTE]
|
|
> Win + R > `powershell` > *Enter*
|
|
|
|
```powershell
|
|
irm https://beatrun.jonnybro.ru/install | iex
|
|
```
|
|
|
|
* Start the game.
|
|
* Select the `Beatrun` gamemode in right lower corner.
|
|
|
|
## Manual Installation
|
|
|
|
1. **[Download this repository](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip)**.
|
|
1. **Delete the `beatrun` folder in *your_game_folder/garrysmod/addons* if you have one.**
|
|
1. Extract the `beatrun-main/beatrun` folder to *your_game_folder/garrysmod/addons*.
|
|
1. If you want to have Discord and Steam Presence:
|
|
* Extract the `beatrun-main/lua` folder to *your_game_folder/garrysmod*.
|
|
1. Start the game.
|
|
1. Select the `Beatrun` gamemode in right lower corner.
|
|
|
|
## Animations
|
|
|
|
Animations installer was removed, now you can switch between animations in Tools menu in Beatrun category.
|
|
|
|
## What's new
|
|
|
|
> [!IMPORTANT]
|
|
> There are many undocumented changes and fixes in this version, you better look at the commits for more specific changes.
|
|
|
|
* Jonny_Bro is hosting **[custom courses database](https://courses.jonnybro.ru)**, which is also **free** to use and **[open sourced](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-docker)**!
|
|
* New gamemode - **Deathmatch** (it's way more fun than Data Theft I promise).
|
|
* "Proper" Kick Glitch just like in **[original game](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
|
|
* In-game configuration menu - you can find it in the Tools menu, in the **Beatrun** category.\
|
|
**All** of the Beatrun settings can be changed in the configuration menu!
|
|
* Discord and Steam Presence.
|
|
* Localization support.\
|
|
Available in 7 languages!
|
|
* Build Mode Tweaks.\
|
|
You can now spawn any prop from Spawn Menu and they will save in your course.
|
|
* Ability to roll after ziplines with CTRL (thanks c4nk <3).
|
|
* Ability to get off of ladders - Press CTRL.
|
|
* Ability to remove ziplines that created with *Zipline Gun* - Press RMB.
|
|
* Arrow that shows the next checkpoint.
|
|
* Server ConVar to allow Overdrive usage in multiplayer - `Beatrun_AllowOverdriveInMultiplayer`.
|
|
* Server ConVar to allow players to spawn props and weapons without admin rights - `Beatrun_AllowPropSpawn`.
|
|
* Server ConVar to toggle the health regeneration - `Beatrun_HealthRegen`.
|
|
* Client ConVars to change HUD colors - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
|
|
* Client ConVar to toggle the grapple ability - `Beatrun_DisableGrapple`.
|
|
* Client ConVar to toggle between old and new Kick Glitch - `Beatrun_OldKickGlitch`.
|
|
* Client ConVar to allow QuickTurn with any weapon or only with *Runner Hands* - `Beatrun_QuickturnHandsOnly`.
|
|
* Small camera punch when diving.
|
|
* SteamID is no longer shown on screen.
|
|
|
|
## Fixes
|
|
|
|
* Some playermodels show up as ERROR in first person.
|
|
* Leaderboard sorting in gamemodes.
|
|
* Grapple usage in courses and gamemodes.
|
|
* Crash in Data Theft when touching Data Bank.
|
|
* PvP damage not going through in gamemodes other than Data Theft.
|
|
* Allowed jumping while walking.
|
|
* You can now roll under things using safety roll.
|
|
* Now grapple moves with the entity it was attached to and other players can see the rope.
|
|
|
|
## Known issues
|
|
|
|
* [Issues](https://github.com/JonnyBro/beatrun/issues).
|
|
|
|
## Related projects
|
|
|
|
* [Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims).
|
|
|
|
## Credits
|
|
|
|
* [All contributors](https://github.com/JonnyBro/beatrun/graphs/contributors) - <3.
|
|
* [EarthyKiller127/datae](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - Original creator of Beatrun.
|
|
* [relaxtakenotes](https://github.com/relaxtakenotes) - Made all of this possible.
|
|
* [MTB](https://www.youtube.com/@MTB396) - Beatrun Reanimated Project.
|
|
* [Fluffy Servers](https://github.com/fluffy-servers/gmod-discord-rpc) - Discord Rich Presence.
|
|
* [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) - Steam Presence (TFA Base creator!).
|