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 and some other stuff

Browse source
This commit is contained in:
LostTrackpad 2024-06-15 17:45:43 +07:00
parent d5bf1b62e2
commit a1e250d73d
2 changed files with 72 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

133
README.md
View file

@ -1,47 +1,52 @@
# Beatrun | Community edition
* [Русский](./README_ru.md)
* [Русский](./README_ru.md)\
*(If you can read English: This isn't maintained, I don't speak Russian)*
**PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS ON OUR SERVER!**\
**WE DOCUMENTED EVERYTHING ENOUGH SO YOU CAN INSTALL THIS YOURSELF PRETTY EASILY**
**PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS ON OUR SERVER!**
Infamous parkour addon for Garry's Mod.\
Fully open sourced and maintained by the community (me 😞).
Infamous parkour gamemode for Garry's Mod.\
Fully open sourced and maintained by the community (like 4 people I think).
> [!IMPORTANT]
> This repository doesn't contain any malicious modules. It does contain some modules for additional functionality like:
> This repository does not contain any malicious modules whatsoever. These modules are present for more functionality however:
>
> * Discord Rich Presence.
> * Steam Presence.
> * Discord Rich Presence
> * Steam Presence
>
> **They are optional and can be removed at any time.**\
> You can find all modules **[here](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
> Check **[Credits](#credits)** section for their source code.
> You can find all compiled modules **[here](lua/bin)** in the repository.\
> Check **[Credits](#credits)** section for module source code.
## Automatic Installation (Recommended | Windows 10/11)
> [!WARNING]
> Windows 7 is not supported.\
> Update already...
Run the command below in Powershell.
> [!NOTE]
> Win + R > `powershell` > *Enter*
```powershell
irm https://beatrun.jonnybro.ru/install | iex
```
* Select the `Beatrun` gamemode in right lower corner.
Not supported. I (LostTrackpad) am not going to set this up.
## Manual Installation
1. **[Download this repository](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip)**.
2. **Delete the `beatrun` folder in *your_game_folder/garrysmod/addons* if you have one.**
3. Extract the `beatrun-main/beatrun` folder to *your_game_folder/garrysmod/addons*.
4. If you want to have Discord and Steam Presence:
* Extract the `beatrun-main/lua` folder to *your_game_folder/garrysmod*.
5. Select the `Beatrun` gamemode in right lower corner.
#### *Method 1: Repository download and extract (easy)*
***Note**: `<Garry's Mod game folder>` is a placeholder for your Garry's Mod game folder.*
1. **[Download this repository](example.com)**. (I'll replace this link later)
2. **Delete the `beatrun` folder in *`<Garry's Mod game folder>/garrysmod/addons`* if you have one.**
3. Extract the `beatrun-main/beatrun` folder to *`<Garry's Mod game folder>/garrysmod/addons`*.
* If you want to have Discord and Steam Presence:
* Extract the `beatrun-main/lua` folder to *`<Garry's Mod game folder>/garrysmod`*.
4. That's it, Beatrun is installed.
#### *Method 2: Using Git and Directory Junctions* ***(Windows 10+ Only!)***
> [!WARNING]
> This method requires:<br>
> * **A working and up to date installation of Windows 10 or above.**
> * A **working and usable** installation of Git for Windows on the system
> * The drive volume you have Garry's Mod on ***must*** use a file system that supports Windows Directory Junctions (this will likely be NTFS)<br>
> [!IMPORTANT]
> ***May*** work on Windows 7/8, but those versions of Windows are **no longer supported**! You really should upgrade if you're running either of those, and I will not provide support!
If you're ready and willing to use this method, read [this](repocontent/WindowsGitInstallGuide.md) guide to continue.
## Animations
@ -50,50 +55,52 @@ irm https://beatrun.jonnybro.ru/install | iex
## Features
> [!IMPORTANT]
> There are many undocumented changes and fixes in this version, you better look at the commits for more specific changes.
> This version has *lots* of undocumented features and fixes. Look into the commit history if you wanna see all of them.
* Jonny_Bro is hosting **[custom courses database](https://courses.jonnybro.ru)**, which is also **free** to use and **[open sourced](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-express)**!
* Jonny_Bro (original repository hoster) is hosting **[custom courses database](https://courses.jonnybro.ru)**, which is ***free***[^1] to use and **[open sourced](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-express)**!
* New gamemode - **Deathmatch** (it's way more fun than Data Theft I promise).
* "Proper" Kick Glitch just like in **[original game](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
* In-game configuration menu - you can find it in the tools menu, in the **Beatrun** category.\
**All** of the Beatrun settings can be changed in the configuration menu!
* Discord and Steam Presence.
* "Proper" kick glitch just like in **[original game](https://www.youtube.com/watch?v=zK5y3NBUStc)**
* Kick glitch behavior type toggle (yep, original kick glitch is still usable!) `Beatrun_OldKickGlitch` to toggle
* In-game configuration menu - you can find it in the tools menu, in the **`Beatrun`** category\
***Most*** Beatrun settings can now be configured there! Use `cvarlist beatrun_` to list all Beatrun options (and some commands)
* Discord and Steam Presence *(only Discord presence is new actually)*
* Localization support.\
Available in 5 languages now!
Now usable in 5+ languages *(mostly, some stuff is locked in English)*
* Build Mode Tweaks.\
You can now spawn any prop from Spawn Menu and they will save in your course.
* Ability to get off of ladders - Press CTRL.
* Ability to remove ziplines that created with *Zipline Gun* - Press RMB.
* Arrow that shows the next checkpoint.
* ConVar to allow Overdrive usage (server) - `Beatrun_AllowOverdriveInMultiplayer`.
* ConVar to allow players to spawn props and weapons without admin rights (server) - `Beatrun_AllowPropSpawn`.
* ConVar to toggle the heatlh regeneration (server) - `Beatrun_HealthRegen`.
* ConVars to change HUD colors (client) - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
* ConVar to toggle the grapple ability (client) - `Beatrun_DisableGrapple`.
* ConVar to toggle between old and new Kick Glitch (client) - `Beatrun_OldKickGlitch`.
* Dismounting from ladders with your duck key (default is `CTRL`)
* Removing ziplines created with Zipline Gun using your alternate fire bind (default is Right Mouse Button)
* Arrow that points to the next checkpoint
* Serverside option to enable Overdrive mode in multiplayer: `Beatrun_AllowOverdriveInMultiplayer`
* Serverside option to allow prop spawning without being an admin: `Beatrun_AllowPropSpawn`.
* Serverside toggle for health regeneration: `Beatrun_HealthRegen`
* You can change HUD colors (client only)! Use `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, and `Beatrun_HUDFloatingXPColor`
* Clientside to allow disabling the grapple: `Beatrun_DisableGrapple`.
* ConVar to allow QuickTurn with any weapon or only with *Runner Hands* (client) - `Beatrun_QuickturnHandsOnly`.
* Small camera punch when diving.
* Your SteamID on the screen is no longer present.
* Your Steam account ID/*SteamID* is no longer shown on screen
## Fixes
* Some playermodels show up as **ERROR**.
* Leaderboard sorting in gamemodes.
* Grapple usage in courses and gamemodes.
* Crash in Data Theft when touching Data Bank.
* Collisions issues - PvP damage not going through in gamemodes other than Data Theft.
* Some playermodels showing up as **`ERROR`**
* Leaderboard sorting in gamemodes
* Allow using the grapple in Time Trial and gamemodes
* Crash in Data Theft when touching Data Bank
* Collision issues - PvP damage not going through in gamemodes other than Data Theft
* Allowed jumping while walking (🤷).
* Tweaked safety roll - now you can roll under things.
* Tweaked safety roll to allow rolling under stuff
* Tweaked some grapple related stuff - now it moves with the entity it was attached to and other players can see the rope.
## TODO
* [ ] Loadouts creation menu for Data Theft and Deathmatch. (idk how to properly implement this for know).
* [ ] Loadouts creation menu for Data Theft and Deathmatch. (I don't do UI stuff, I can't do this).
## Known issues
* [Issues](https://github.com/JonnyBro/beatrun/issues).
* Maybe more, i forgor 💀.
* [Issues on Jonny's original fork](https://github.com/JonnyBro/beatrun/issues)\
I'm not kidding, check there first for problems. ***Do not** report issues with this fork there.*
* [Issues on this fork](https://github.com/LostTrackpad/beatrun-forked/issues)\
Report any issues with this fork here, and any feature requests you may want.
## Related projects
@ -101,9 +108,11 @@ You can now spawn any prop from Spawn Menu and they will save in your course.
## Credits
* [All contributors](https://github.com/JonnyBro/beatrun/graphs/contributors) - <3.
* [EarthyKiller127](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit.
* [relaxtakenotes](https://github.com/relaxtakenotes) - Made all of this possible.
* [MTB](https://www.youtube.com/@MTB396) - Beatrun Reanimated Project.
* [Fluffy Servers](https://github.com/fluffy-servers/gmod-discord-rpc) - Discord Rich Presence.
* [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) - Steam Presence.
* [All contributors](https://github.com/JonnyBro/beatrun/graphs/contributors) for making Beatrun better
* [EarthyKiller127](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) / datæ for making the original Beatrun gamemode *(and obfuscating it and putting it into DLL files...really?)*
* [relaxtakenotes](https://github.com/relaxtakenotes) for even making all this possible
* [MTB](https://www.youtube.com/@MTB396) for Beatrun Reanimated Project
* [Fluffy Servers](https://github.com/fluffy-servers/gmod-discord-rpc) for Discord Rich Presence module
* [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) for Steam Presence module
[^1] *A Steam account with a copy of Garry's Mod is required. Ask them why if you're curious.*

1
repocontent/WindowsGitInstallGuide.md Normal file
View file

@ -0,0 +1 @@
This guide is currently a work in progress. Check back later. Use [Method 1](../README.md#method-1-repository-download-and-extract-easy) for now.