mirror of
https://github.com/JonnyBro/beatrun.git
synced 2024-12-29 21:33:02 +05:00
74 lines
4.3 KiB
Markdown
74 lines
4.3 KiB
Markdown
# Beatrun | Community version
|
|
|
|
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:
|
|
* 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)
|
|
|
|
**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))**
|
|
|
|
# Installation (Manual)
|
|
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*.
|
|
* `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>
|
|
|
|
# Installation (Automatic | Windows only)
|
|
Run the command below in the Powershell. (Win + R --> powershell --> the command below)
|
|
```powershell
|
|
iex (iwr "beatrun.ru/install.ps1" -UseBasicParsing)
|
|
```
|
|
|
|
## Animations
|
|
You can use "**Beatrun Animations Installer**" for custom animations. Currently there's:
|
|
* Beatrun Reanimated
|
|
* Fixed Original<br><br>
|
|
|
|
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).
|
|
|
|
## Changes and fixes done by me
|
|
* Created a [custom online courses database](https://courses.beatrun.ru), which is also free and [open source](https://github.com/relaxtakenotes/beatrun-courses-server/) 🤯!
|
|
* Added an in-game config menu - You can find it in the tool menu, in the *Beatrun* Category!\
|
|
All of the settings below can be changed in the configuration menu.
|
|
* Added the ability Getting off of ladders.
|
|
* Allowed jumping while slowwalking.
|
|
* Done various tweaks to the Time Trials Menu (F4).
|
|
* Added an arrow that shows the next checkpoint.
|
|
* 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 convars to change HUD's 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 step 3).
|
|
* 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.
|
|
|
|
## Notable changes and fixes done by the community
|
|
* Made quick turnaround work only with `Unarmed`.
|
|
* Fixed leaderboard sorting in gamemodes.
|
|
* Fixed grapple usage in courses and gamemodes.
|
|
* Fixed a crash in DataTheft when touching data bank.
|
|
* Fixed an error on course load.
|
|
* Fixed collisions issues. (you getting stuck in walls for no reason or player to player damage not going through in gamemodes other than datatheft)
|
|
* Added Proper Kick Glitch ([Like in original ME](https://www.youtube.com/watch?v=zK5y3NBUStc)). (cry about prediction errors l0l)
|
|
* Tweaked safety roll, now you can roll under things.
|
|
* 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.
|
|
|
|
## TODO
|
|
- [ ] Gamemodes menu.
|
|
|
|
# Related
|
|
* [beatrun-anims](https://github.com/JonnyBro/beatrun-anims) - Decompiled beatrun animations.
|
|
|
|
# Credits <3
|
|
* All contributors.
|
|
* [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.
|
|
* [earthykiller](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit code.
|