jonny_bro/beatrun
1
0
Fork 0
mirror of https://github.com/JonnyBro/beatrun.git synced 2024-12-29 05:13:02 +05:00
Code Issues Projects Releases Packages Wiki Activity
beatrun/README.md
LostTrackpad a1e250d73d Update README and some other stuff
2024-06-15 17:45:43 +07:00

6 KiB
Raw Blame History

Beatrun | Community edition

  • Русский
    (If you can read English: This isn't maintained, I don't speak Russian)

PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS ON OUR SERVER!

Infamous parkour gamemode for Garry's Mod.
Fully open sourced and maintained by the community (like 4 people I think).

Important

This repository does not contain any malicious modules whatsoever. These modules are present for more functionality however:

  • Discord Rich Presence
  • Steam Presence

They are optional and can be removed at any time.
You can find all compiled modules here in the repository.
Check Credits section for module source code.

Automatic Installation (Recommended | Windows 10/11)

Not supported. I (LostTrackpad) am not going to set this up.

Manual Installation

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. (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:

  • 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)

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 guide to continue.

Animations

Please refer to this file.

Features

Important

This version has lots of undocumented features and fixes. Look into the commit history if you wanna see all of them.

  • Jonny_Bro (original repository hoster) is hosting custom courses database, which is free[^1] to use and open sourced!
  • New gamemode - Deathmatch (it's way more fun than Data Theft I promise).
  • "Proper" kick glitch just like in original game
    • 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.
    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.
  • 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 Steam account ID/SteamID is no longer shown on screen

Fixes

  • 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 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. (I don't do UI stuff, I can't do this).

Known issues

Related projects

Credits

[^1] A Steam account with a copy of Garry's Mod is required. Ask them why if you're curious.