2023-08-14 18:45:34 +05:00
# Beatrun | Community version
2023-05-25 23:53:16 +05:00
2023-08-14 18:45:34 +05:00
Infamous parkour addon for Garry's Mod, fully open sourced and maintained by the community.
This version does not include malicious modules, code or networking. What it does contain is:
2023-08-14 20:07:37 +05:00
* Lua modules for Discord Rich Presence
* Lua modules for Steam Presence
* Network connectivity for courses (activates only when you load or upload courses, and by default `courses.beatrun.ru` is used)
2023-08-14 18:45:34 +05:00
**All of this is optional and you may remove all of it. (modules are located [here ](https://github.com/JonnyBro/beatrun/blob/master/lua/bin/ ) and online courses functionality is [here ](https://github.com/JonnyBro/beatrun/blob/master/beatrun/gamemodes/beatrun/gamemode/cl/OnlineCourse.lua ))**
2023-09-13 22:32:57 +05:00
**PLEASE READ ALL BEFORE ASKING QUESTIONS ON OUR SERVER!**
# (Prefered) Installation (Automatic | Windows only)
Run the command below in the Powershell.
> (Win + R > powershell > command in question)
```powershell
iex (iwr "beatrun.ru/install.ps1" -UseBasicParsing)
```
## Installation (Manual)
2023-08-14 18:45:34 +05:00
1. Download this repository [here ](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip ).
2. Delete the `beatrun` folder in *addons* if you have one!
3. Extract the `beatrun` folder to *your_game_folder/garrysmod/addons* .
4. Extract the `lua` folder to *your_game_folder/garrysmod* .
2023-08-26 14:28:39 +05:00
* `lua` folder contains modules for Discord Rich Presense and Steam Presence. They are optional. You can find their source code in the [credits ](https://github.com/JonnyBro/beatrun?tab=readme-ov-file#credits-3 ) section< br >< br >
2023-07-28 21:47:46 +05:00
2023-08-14 18:45:34 +05:00
## Animations
2023-09-13 11:48:01 +05:00
You can use "**BeatrunAnimInstaller**" (located in `beatrun` [here ](https://github.com/JonnyBro/beatrun/tree/master/beatrun )) for custom animations. Currently there's:
2023-08-14 18:45:34 +05:00
* Beatrun Reanimated
2023-08-26 14:27:10 +05:00
* Fixed Original< br >< br >
2023-08-15 16:01:17 +05:00
Start the executable and press a key on your keyboard with the number of the animation you want to install (if nothing's changed, run the program as admin).< br >
Installer's source can be found [here ](/BeatrunAnimInstaller ).
2023-05-25 23:53:16 +05:00
2023-08-14 18:45:34 +05:00
## Changes and fixes done by me
2023-09-13 22:32:57 +05:00
* Jonny_Bro is hosting [custom online courses database ](https://courses.beatrun.ru ), which is also free and [open source ](https://github.com/relaxtakenotes/beatrun-courses-server/ ) 🤯!
* Added a new gamemode - *Deathmatch* , it's like Data Theft, but you collect kills not cubes! (it's way more fun I promise)
2023-08-14 18:45:34 +05:00
* Added an in-game config menu - You can find it in the tool menu, in the *Beatrun* Category!\
2023-09-13 22:32:57 +05:00
**All** of the Beatrun settings can be changed in the configuration menu.
* Added the ability to get off of ladders.
* Allowed jumping while slowwalking (🤷).
2023-08-14 18:45:34 +05:00
* Done various tweaks to the Time Trials Menu (F4).
* Added an arrow that shows the next checkpoint.
2023-09-13 22:32:57 +05:00
* Added a ConVar to allow Overdrive usage on the server - `Beatrun_AllowOverdriveInMultiplayer` .
* Added a ConVar to toggle between old and new (like in ME) Kick-Glitch - `Beatrun_OldKickGlitch` .
* Added some ConVars to change HUD colors - `Beatrun_HUDTextColor` , `Beatrun_HUDCornerColor` , `Beatrun_HUDFloatingXPColor` .
* Added a ConVar to allow players to spawn props without admin rights - `Beatrun_AllowPropSpawn` .
* Added a ConVar to disable grapple ability - `Beatrun_DisableGrapple` .
* Implemented Discord Rich Presence using open source tools (See [credits ](https://github.com/JonnyBro/beatrun?tab=readme-ov-file#credits-3 )).
2023-08-14 18:45:34 +05:00
* Added small camera punch when diving.
* Added the ability to remove ziplines that created with *Zipline Gun* - RMB.
* SteamID in the right corner is no longer present.
2023-08-14 20:07:37 +05:00
2023-08-14 18:45:34 +05:00
## Notable changes and fixes done by the community
2023-09-03 15:36:48 +05:00
* Made QuickTurn work only with `Runner Hands` .
2023-05-31 19:49:47 +05:00
* Fixed leaderboard sorting in gamemodes.
* Fixed grapple usage in courses and gamemodes.
2023-08-14 18:45:34 +05:00
* Fixed a crash in DataTheft when touching data bank.
* Fixed an error on course load.
2023-09-13 22:32:57 +05:00
* Fixed collisions issues. (PvP damage not going through in gamemodes other than DataTheft)
2023-08-14 20:07:37 +05:00
* Added Proper Kick Glitch ([Like in original ME](https://www.youtube.com/watch?v=zK5y3NBUStc)). (cry about prediction errors l0l)
2023-06-16 20:49:27 +05:00
* Tweaked safety roll, now you can roll under things.
2023-08-14 18:45:34 +05:00
* Made it possible to dive to your death =).
* Added some grapple related stuff. Now it moves with the entity it was attached to and other players can see the rope.
2023-07-11 22:49:47 +05:00
2023-07-28 21:47:46 +05:00
## TODO
2023-09-13 22:32:57 +05:00
- [ ] Gamemodes menu. (idk how to properly implement this for know)
2023-07-28 21:47:46 +05:00
2023-07-24 12:11:47 +05:00
# Related
2023-09-13 22:32:57 +05:00
* [beatrun-anims ](https://github.com/JonnyBro/beatrun-anims ) - Decompiled and reworked Beatrun animations.
2023-07-24 12:11:47 +05:00
# Credits <3
* All contributors.
2023-09-13 22:32:57 +05:00
* [EarthyKiller127 ](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ ) - He made that piece of shit.
* [relaxtakenotes ](https://github.com/relaxtakenotes ) - Made all of this possible.
2023-08-09 08:38:38 +05:00
* [MTB ](https://www.youtube.com/@MTB396 ) - Beatrun Reanimated project.
* [Discord Rich Presence ](https://github.com/fluffy-servers/gmod-discord-rpc ) by Fluffy Servers.
* [Steam Presence ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer ) by YuRaNnNzZZ.
