Update README.md

This commit is contained in:
Jonny_Bro (Nikita) 2023-07-28 21:47:46 +05:00
parent 95142a82fa
commit afcd45f647

View file

@ -1,8 +1,11 @@
# beatrun
Modified beatrun's source code.<br><br>
# Beatrun
Modified Beatrun's source code.<br><br>
There are 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.<br><br>
This version should works on any version of the game (Base version is known good, Chromium has some issues and I don't have time to fix them).
## Animations
You can use *Beatrun Animations Installer* if you want to change your animations, there are new ones (from Beatrun Reanimated project) and OG ones, OG is default.
# Installation
1. **Delete or disable VManip (Base) that downloaded from Workshop!**
2. **Delete `beatrun` and `vmaniprework` folders in *addons* if you have one!**
@ -11,7 +14,7 @@ This version should works on any version of the game (Base version is known good
* `lua` folder constains modules for Discord Rich Presense and Steam Presence to work. They are open source, visit [this](https://github.com/fluffy-servers/gmod-discord-rpc) to see the sources of DRP and [this](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) for SP.
## Changes added by me
* [Custom online courses database](https://courses.beatrun.ru)! It's free 🤯
* [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.
* Allow Overdrive usage on the server - `Beatrun_AllowOverdriveInMultiplayer`.
@ -24,9 +27,6 @@ All of the settings below can be changed in the configuration menu.
* Ability to remove ziplines that created with *Zipline Gun* - RMB.
* Removed your SteamID from right corner, because I can.
## TODO
- [ ] Gamemodes menu
## Fixes and changes from previous version
* `Beatrun_DisableGrapple` - Disables grapple ability.
@ -47,9 +47,12 @@ All of the settings below can be changed in the configuration menu.
* More reliable grappling.
* Merged some anims into 1 file.
## TODO
- [ ] Gamemodes menu
# Related
[beatrun-anims](https://github.com/JonnyBro/beatrun-anims) - Sources of animations from Beatrun. You can also find OG animations here
[Beatrun-Anims](https://github.com/JonnyBro/beatrun-anims) - Sources of animations from Beatrun.
# Credits <3
* modeltexturesbones - Changed anims a bit.
* modeltexturesbones - Beatrun Reanimated project.
* All contributors.