Beatrun | Community Edition

Join our Discord Community!

Русский | Russian

---

About

Beatrun is an infamous parkour gamemode for Garry's Mod, now fully open-sourced and maintained by the community. It includes various improvements, new features, and enhanced functionality.

[!WARNING] This repository contains optional modules for showing custom statuses in Discord and Steam.
They are not required for Beatrun to work.

You can find those modules here.
And you can find their source code in the credits.

Installation

Steam Workshop

[!WARNING] Don't forget to delete any other Beatrun versions from garrysmod/addons!

1. Subscribe to this addon.
2. Start the game.
3. Select the Beatrun gamemode in the bottom-right corner.

Manual Installation

1. Download the repository.
2. Delete the beatrun folder in your_game_folder/garrysmod/addons, if it exists.
3. Extract beatrun-main into your_game_folder/garrysmod/addons.
   • (Optional) For Discord and Steam Presence, move the contents of beatrun-main/lua/bin to your your_game_folder/garrysmod/lua/bin (create the folder if it doesn't exists).
4. Start the game.
5. Select the Beatrun gamemode in the bottom-right corner.

---

Features and Updates

[!NOTE] There are plenty of changes and fixes that are not documented here. If you are interested - feel free to read the commits.

New Features

• In-game Courses Database UI.
  • Accessible by pressing F4 (source code).
  • Default one is hosted by @JonnyBro.
• New Deathmatch gamemode.
• "Proper" Kick Glitch similar to the original game.
• In-game configuration in the Tools menu under Beatrun. All settings can be changed from there.
• Localization support in 8 languages.
• Enhanced Build Mode: spawn props from the Spawn Menu, and they will save in your course.
• Random weapon loadouts from MW Base, ARC9, ARCCW and TFA. Or create your own in !Helpers.lua!
• Race your Ghost: a ghost of your best time in the current course.
• Various new/fixed abilities:
  • Roll after ziplines: Press +duck (CTRL by default).
  • Dismount ladders: Press +duck (CTRL by default).
  • Remove ziplines created with Zipline Gun: Press +attack2 (RMB by default).
  • Arrow to the next checkpoint for easier navigation.
• New server and client configuration variables:
  • Server:
    • Beatrun_AllowOverdriveInMultiplayer: Allow Overdrive in multiplayer.
    • Beatrun_AllowPropSpawn: Let players spawn props without admin rights.
    • Beatrun_AllowWeaponSpawn: Let players spawn weapons without admin rights.
    • Beatrun_HealthRegen: Toggle health regeneration.
  • Client:
    • Beatrun_HUDTextColor, Beatrun_HUDCornerColor, Beatrun_HUDFloatingXPColor: Customize HUD colors.
    • Beatrun_DisableGrapple: Toggle the grapple ability.
    • Beatrun_KickGlitch: Switch between old and new Kick Glitch versions.
    • Beatrun_QuickturnHandsOnly: Restrict QuickTurn to the Runner Hands weapon.
• Other improvements:
  • Small camera punch effect when diving.
  • SteamID no longer displayed on your screen.

Fixes

• Fixed playermodels showing as ERROR in first person.
• Improved leaderboard sorting in gamemodes.
• Fixed crashes and issues with Data Theft gamemode.
• Enabled jumping while walking.
• Grapple now follows moving entities and visible to other players.

---

Animations

You can now change animations in the Tools menu under the Beatrun category.

---

Known Issues

• See the full list of issues here.

---

Related Projects

• Beatrun Reanimated Project

---

Credits

• All contributors ❤️
• EarthyKiller127/datae - Original creator of Beatrun.
• relaxtakenotes - Made this project possible.
• MTB - Beatrun Reanimated Project.
• Fluffy Servers - Discord Rich Presence.
• YuRaNnNzZZ - Steam Presence.

Fonts

[!NOTE] They could be wrong, I tried to find the original sources.

• x14y24pxHeadUpDaisy
• Datto D-DIN

Star History

<!-- markdownlint-disable MD033 --> <a href="https://www.star-history.com/#JonnyBro/beatrun&type=date&legend=top-left"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=JonnyBro/beatrun&type=date&theme=dark&legend=top-left" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=JonnyBro/beatrun&type=date&legend=top-left" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=JonnyBro/beatrun&type=date&legend=top-left" /> </picture> </a>