jonny_bro/beatrun
1
0
Fork 0
mirror of https://github.com/JonnyBro/beatrun.git synced 2024-12-28 12:53:02 +05:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Jonny_Bro (Nikita) 2023-08-14 20:07:37 +05:00
parent 14b4d71f45
commit a8ec8f0637
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -3,9 +3,9 @@
Infamous parkour addon for Garry's Mod, fully open sourced and maintained by the community. 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: This version does not include malicious modules, code or networking. What it does contain is:
* Lua modules for discord rich presence * Lua modules for Discord Rich Presence
* Lua modules for steam 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) * 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))** **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))**
@ -17,7 +17,7 @@ This version does not include malicious modules, code or networking. What it doe
* `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<br><br> * `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<br><br>
# Installation (Automatic | Windows only) # Installation (Automatic | Windows only)
Run the command below in the Powershell. (win + r --> powershell --> the command in question) Run the command below in the Powershell. (Win + R --> powershell --> the command in question)
```powershell ```powershell
iex (iwr "beatrun.ru/install.ps1") iex (iwr "beatrun.ru/install.ps1")
``` ```
@ -29,10 +29,10 @@ You can use "**Beatrun Animations Installer**" for custom animations. Currently
<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). 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> <br>
Installer source can be found [here]([/BeatrunAnimInstaller/](https://github.com/JonnyBro/beatrun/tree/master/BeatrunAnimInstaller)) Installer source can be found [here](/BeatrunAnimInstaller)
## Changes and fixes done by me ## 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) 🤯! * 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!\ * 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. All of the settings below can be changed in the configuration menu.
* Added the ability Getting off of ladders. * Added the ability Getting off of ladders.
@ -48,7 +48,7 @@ All of the settings below can be changed in the configuration menu.
* Added small camera punch when diving. * Added small camera punch when diving.
* Added the ability to remove ziplines that created with *Zipline Gun* - RMB. * Added the ability to remove ziplines that created with *Zipline Gun* - RMB.
* SteamID in the right corner is no longer present. * SteamID in the right corner is no longer present.
## Notable changes and fixes done by the community ## Notable changes and fixes done by the community
* Made quick turnaround work only with `Unarmed`. * Made quick turnaround work only with `Unarmed`.
* Fixed leaderboard sorting in gamemodes. * Fixed leaderboard sorting in gamemodes.
@ -56,7 +56,7 @@ All of the settings below can be changed in the configuration menu.
* Fixed a crash in DataTheft when touching data bank. * Fixed a crash in DataTheft when touching data bank.
* Fixed an error on course load. * 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) * 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) * 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. * Tweaked safety roll, now you can roll under things.
* Made it possible to dive to your death =). * 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. * Added some grapple related stuff. Now it moves with the entity it was attached to and other players can see the rope.