From cd66f1ec91b75608865ba341488a71d891204b6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D0=B0=D0=BB=D0=B0=D0=B2=D0=B0=D1=82=20=D0=A2=D0=B0?= =?UTF-8?q?=D0=B8=D1=80=D0=BE=D0=B2?= <91839650+relaxtakenotes@users.noreply.github.com> Date: Mon, 14 Aug 2023 13:45:34 +0000 Subject: [PATCH] awesome sauce --- README.md | 105 +++++++++++++++++++++++++++--------------------------- 1 file changed, 53 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 997fab7..34aefc8 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,75 @@ -# Beatrun -Modified Beatrun's source code.

-There are some Lua modules, they are for Discord Rich Presence and Steam Presence to work.
-If you want pure Lua just don't extract them, but your Level and Map will not be shown in your Discord and Steam statuses.

-This version should works on any version of the game (Base version is known good, x64 has some issues and I'm trying to fix them when I can). +# Beatrun | Community version -## Animations -You can use **Beatrun Animations Installer** if you want to change your animations, there are new ones (from Beatrun Reanimated project) and OG (but fixed) ones, OG is default.
-Just start the exe and press a key on your keyboard with the number of the animations you want to install (If it doesn't change animations, run installer as admin).
-Installer source can be found [here](/BeatrunAnimInstaller/) +Infamous parkour addon for Garry's Mod, fully open sourced and maintained by the community. -# Installation -0. Download this repository [here](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip) (should be always up-to-date). -1. **Delete `beatrun` folder in *addons* if you have one!** -2. Extract `beatrun` folder to *your_game_folder/garrysmod/addons*. -3. Extract `lua` folder to *your_game_folder/garrysmod*. - * `lua` folder constains modules for Discord Rich Presense and Steam Presence to work. They are open source, you can find links at the [Credits](https://github.com/JonnyBro/beatrun#credits) section.

- -**OR**

-1. Run the script below in the Powershell. -> You can download this file yourself and check the contents, there is nothing malicious. +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#credits) section

+ +# Installation (Automatic | Windows only) +Run the command below in the Powershell. (win + r --> powershell --> the command in question) ```powershell iex (iwr "beatrun.ru/install.ps1") ``` -## Changes added by me -* [Custom online courses database](https://courses.beatrun.ru), it's free 🤯! -* Configurations 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. -* Getting off of ladders. -* Jumping while walking. -* Various tweaks to Time Trials Menu (F4). -* Arrow that shows the next checkpoint. -* Allow Overdrive usage on the server - `Beatrun_AllowOverdriveInMultiplayer`. -* Toggle between old and new (like in ME) Kick-Glitch - `Beatrun_OldKickGlitch`. -* Change HUD's colors - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`. -* Allow players to spawn props without admin rights - `Beatrun_AllowPropSpawn`. -* Disable grapple ability - `Beatrun_DisableGrapple`. -* Discord Rich Presence (See step 3). -* Small camera punch when diving. -* Ability to remove ziplines that created with *Zipline Gun* - RMB. -* Removed your SteamID from right corner, because I can. +## Animations +You can use "**Beatrun Animations Installer**" for custom animations. Currently there's: +* Beatrun Reanimated +* Fixed Original +
+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). +
+Installer source can be found [here]([/BeatrunAnimInstaller/](https://github.com/JonnyBro/beatrun/tree/master/BeatrunAnimInstaller)) -## Fixes and changes from previous version -* Just check the commits :shrug:. +## 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/tree/main) 🤯! +* 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. -# All changes and fixes -* Course saving works with compression and without. -* Quick turnaround only with `Unarmed`. +## 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 crash in DataTheft when touching data bank. -* Fixed error on course load. -* Fixed collisions issues. -* Fixed and tweaked player-player weapon damage. -* Proper Kick Glitch (Like in original ME: https://www.youtube.com/watch?v=zK5y3NBUStc). +* 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. -* You can now dive to your death =). -* Grapple fixes. Now it moves with entity it attached to and other players can see it. -* More reliable grappling. -* Merged some anims into 1 file. +* 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) - Sources of animations from Beatrun. +* [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. -* [datae](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit code. +* [earthykiller](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit code.