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

Rewrite READMEs

Browse source
This commit is contained in:
Jonny_Bro (Nikita) 2024-09-20 08:58:43 +05:00 committed by GitHub
parent 3418007f8e
commit 9361b3b75c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 98 additions and 108 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -7,29 +7,27 @@
* [Русский](./README.ru.md)
**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!**
Infamous parkour addon for Garry's Mod.\
Fully open sourced and maintained by the community (me 😞).
Infamous parkour addon for Garry's Mod. Fully open sourced and maintained by the community (me 😞).
> [!IMPORTANT]
> This repository doesn't contain any malicious modules. It does contain some modules for additional functionality like:
> This repository doesn't contain any malicious modules. However, we have some modules for additional functionality:
>
> * Discord Rich Presence.
> * Steam Presence.
>
> **They are optional and can be removed at any time.**\
> **They are completely 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.
## Automatic Installation (Recommended | Windows 10/11)
> [!WARNING]
> Windows 7 is not supported.\
> Update already...
> Windows 7 and old versions of Windows 10 are not supported.\
> Please update.
Run the command below in Powershell.
Run the command below in Powershell (run as admin if your Steam or game located in a C: drive).
> [!NOTE]
> Win + R > `powershell` > *Enter*
@ -37,69 +35,66 @@ Run the command below in Powershell.
irm https://beatrun.jonnybro.ru/install | iex
```
* Start the game.
* Select the `Beatrun` gamemode in right lower corner.
## 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:
1. **Delete the `beatrun` folder in *your_game_folder/garrysmod/addons* if you have one.**
1. Extract the `beatrun-main/beatrun` folder to *your_game_folder/garrysmod/addons*.
1. 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.
1. Start the game.
1. Select the `Beatrun` gamemode in right lower corner.
## Animations
[Please refer to this file.](beatrun/README.md)
Animations installer was removed, now you can switch between animations in Tools menu in Beatrun category.
## Features
## What's new
> [!IMPORTANT]
> There are many undocumented changes and fixes in this version, you better look at the commits for more specific changes.
* 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 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-docker)**!
* 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.\
* 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.
* Localization support.\
Available in 7 languages!
* Build Mode Tweaks.\
You can now spawn any prop from Spawn Menu and they will save in your course.
* Ability to roll after ziplines with CTRL 🤯 (thanks c4nk <3).
You can now spawn any prop from Spawn Menu and they will save in your course.
* Ability to roll after ziplines with CTRL (thanks c4nk <3).
* 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`.
* ConVar to allow QuickTurn with any weapon or only with *Runner Hands* (client) - `Beatrun_QuickturnHandsOnly`.
* Server ConVar to allow Overdrive usage in multiplayer - `Beatrun_AllowOverdriveInMultiplayer`.
* Server ConVar to allow players to spawn props and weapons without admin rights - `Beatrun_AllowPropSpawn`.
* Server ConVar to toggle the health regeneration - `Beatrun_HealthRegen`.
* Client ConVars to change HUD colors - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
* Client ConVar to toggle the grapple ability - `Beatrun_DisableGrapple`.
* Client ConVar to toggle between old and new Kick Glitch - `Beatrun_OldKickGlitch`.
* Client ConVar to allow QuickTurn with any weapon or only with *Runner Hands* - `Beatrun_QuickturnHandsOnly`.
* Small camera punch when diving.
* Your SteamID on the screen is no longer present.
* SteamID is no longer shown on screen.
## Fixes
* Some playermodels show up as **ERROR**.
* Some playermodels show up as ERROR in first person.
* 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.
* Allowed jumping while walking (🤷).
* Tweaked safety roll - now you can roll under things.
* 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).
* PvP damage not going through in gamemodes other than Data Theft.
* Allowed jumping while walking.
* You can now roll under things using safety roll.
* Now grapple moves with the entity it was attached to and other players can see the rope.
## Known issues
* [Issues](https://github.com/JonnyBro/beatrun/issues).
* Maybe more, i forgor 💀.
## Related projects
@ -108,8 +103,8 @@ 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.
* [EarthyKiller127/datae](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - Original creator of Beatrun.
* [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.
* [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) - Steam Presence (TFA Base creator!).

133
README.ru.md
View file

@ -3,33 +3,31 @@
[![forthebadge](https://forthebadge.com/images/featured/featured-powered-by-electricity.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com)
[Нажми чтобы присоединиться к нашему Discord серверу!](https://discord.gg/93Psubbgsg)
[Нажмите чтобы присоедениться к нашему Discord серверу!](https://discord.gg/93Psubbgsg)
* [English](./README.md)
* [Русский](./README.ru.md)
**ПОЖАЛУЙСТА, ПРОЧИТАЙТЕ ЭТОТ ФАЙЛ ПЕРЕД ТЕМ КАК ЗАДАВАТЬ ВОПРОСЫ!**\
**МЫ ОПИСАЛИ ДОСТАТОЧНО, ЧТОБЫ ВЫ МОГЛИ УСТАНОВИТЬ ЭТОТ МОД САМОСТОЯТЕЛЬНО**
**ПОЖАЛУЙСТА, ПРОЧИТАЙТЕ ВЕСЬ ДОКУМЕНТ ПЕРЕД ТЕМ КАК ЗАДАВАТЬ ВОПРОСЫ!**
Печально известный паркур мод для Garry's Mod.\
Мод с открытым исходным кодом и поддерживаемый сообществом (мной 😞).
Печально известный паркур аддон для Garry's Mod. Теперь, с полностью открытым исходным кодом и поддерживаемый сообществом (мной 😞).
> [!IMPORTANT]
> Данный проект не содержит вредоносных модулей. Здесь присутствуют модули для доп. функций, таких как:
> Данный репозиторий не содержит вредоносных модулей. Однако, мы имеем несколько модулей для дополнительного функционала:
>
> * Показ статуса в Discord.
> * Показ статуса в Steam.
> * Модуль для показа статуса в Discord.
> * Модуль для показа статуса в Steam.
>
> **Данные модули опциональны и могут быть удалены в любой момент.**\
> Все модули можно найти **[здесь](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
> Проверьте **[Благодарности](#благодарности)** чтобы найти исходный код модулей.
> **Они не обязательны и могут быть удалены в любой момент.**\
> Список всех модуйлей находится **[здесь](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
> Проверьте **[Благодарности](#благодарности)** чтобы найти их исходный код.
## Автоматическая установка (Рекомендуемое | Windows 10/11)
## Автоматическая установка (Рекомендуется | Windows 10/11)
> [!WARNING]
> Windows 7 не поддерживается.\
> Кому-то давно пора обновиться...
> Windows 7 и старые сборки Windows 10 не поддерживаются.
> Обновитесь, пожалуйста.
Запустите команду в Powershell.
Запустите команду ниже в Powershell (запустите от администратора если Steam или игра расположены на диске C:).
> [!NOTE]
> Win + R > `powershell` > *Enter*
@ -37,79 +35,76 @@
irm https://beatrun.jonnybro.ru/install | iex
```
* Выберите режим `Beatrun` в правом нижнем углу.
* Запустить игру.
* Выбрать режим `Beatrun` в правом нижнем углу.
## Ручная установка
1. **[Скачайте проект](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip)**.
2. **Удалите папку `beatrun` по пути *путь_к_игре/garrysmod/addons* если присутствует.**
3. Извлеките папку `beatrun-main/beatrun` по пути *путь_к_игре/garrysmod/addons*.
4. Если вы хотите показ статусов в Discord и Steam:
* Извлеките папку `beatrun-main/lua` по пути *путь_к_игре/garrysmod*.
5. Выберите режим `Beatrun` в правом нижнем углу.
1. **[Скачать репозиторий](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip)**.
1. **Удалить папку `beatrun` в *путь_к_игре/garrysmod/addons*, если у вас такова имеется.**
1. Извлечь папку `beatrun-main/beatrun` в *путь_к_игре/garrysmod/addons*.
1. Если вы хотите показ статуса в Discord и Steam:
* Извлечь папку `beatrun-main/lua` в *путь_к_игре/garrysmod*.
1. Запустить игру.
1. Выбрать режим `Beatrun` в правом нижнем углу.
## Анимации
[Читаем тут](beatrun/README.md)
Установщик анимаций был удалён, теперь анимации можно переключить в меню Инструментов в категории Beatrun.
## Особенности
## Отличия от оригинала
> [!IMPORTANT]
> Множество изменений и исправлений не задокументированы, обратитесь к списку коммитов для более подробного списка изменений.
> Множество изменений не задокументированы, проверьте коммиты для полного списка изменений.
* Jonny_Bro поддерживает **[свою базу курсов](https://courses.jonnybro.ru)**, которая так же **бесплатна** к использованию и имеет **[открытый исходный код](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-express)**!
* Новый режим - **Deathmatch** (намного веселее чем Data Theft, честно).
* "Правильный" Kick Glitch прямо как в **[оригинальной игре](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
* Меню настроек - найти его можно в меню инструментов, в категории **Beatrun**.\
**Все** настройки Beatrun можно найти там!
* Показ статусов в Steam и Discord.
* Поддержка локализаций.\
Доступно 7 языков!
* Улучшения режима строительства.
Можно заспавнить любой проп из меню спавна и он сохранится в курсе.
* Возможность переката после зиплайнов на CTRL 🤯 (спасибо c4nk <3).
* Возможность спрыгивать с лестниц - Нажмите CTRL.
* Возможность удалять зиплайны созданные *Zipline Gun* - Нажмите ПКМ.
* Стрелка, показывающая местоположение след. контрольной точки.
* Переменная, разрешающая использование Overdrive (сервер) - `Beatrun_AllowOverdriveInMultiplayer`.
* Переменная, разрешающая создание объектов без прав администратора (сервер) - `Beatrun_AllowPropSpawn`.
* Переменная, переключающая регенерацию здоровья (сервер) - `Beatrun_HealthRegen`.
* Переменные, изменяющие цвет HUD (клиент) - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
* Переменная, переключающая использование крюка-кошки (клиент) - `Beatrun_DisableGrapple`.
* Переменная, переключающая режим Kick Glitch (клиент) - `Beatrun_OldKickGlitch`.
* Переменная, переключающая использование Quickturn только с *Runner Hands* или любым оружием (клиент) - `Beatrun_QuickturnHandsOnly`.
* Небольшой толчёк камеры при нырянии.
* Убран SteamID с экрана.
* Jonny_Bro поддерживает свою **[базу курсов](https://courses.jonnybro.ru)**, которая так же **бесплатна** для использования и имеет **[открытый исходный код](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-docker)**!
* Новый режим - **Deathmatch** (намного интереснее Data Theft, честно).
* Оригинальный Kick Glitch как в **[оригинальной игре](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
* Внутриигровое меню настроек - оно находится в меню Инструментов в категории **Beatrun**.\
Там можно найти **все** настройки Beatrun!
* Показ статуса в Discord и Steam.
* Поддержка локализации.\
Доступно на 7 языках!
* Изменения в режиме строительства курсов.\
Любой проп из меню спавна теперь сохраняется в курсе.
* Возможность переката на кнопку приседания (CTRL) после зиплайнов (спасибо c4nk <3).
* Возможность спрыгивать с лестниц на кнопку приседания (CTRL).
* Возможность удалять зиплайны, созданные *Zipline Gun* по нажатию на второстепенный огонь (ПКМ).
* Стрелка, указывающая на следующий чекпоинт.
* Серверная переменная которая разрешает использование Overdrive в мультиплеере - `Beatrun_AllowOverdriveInMultiplayer`.
* Серверная переменная которая разрешает создание оружия и объектов из меню спавна без прав администратора - `Beatrun_AllowPropSpawn`.
* Серверная переменная которая переключает регенерацию здоровья - `Beatrun_HealthRegen`.
* Клиентские переменные для изменения цвета интерфейса - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
* Клиентская переменная которая переключает использование крюка-кошки - `Beatrun_DisableGrapple`.
* Клиентская переменная которая переключает использование старого и нового Kick Glitch - `Beatrun_OldKickGlitch`.
* Клиентская переменная которая переключает быстрый разворот с оружием или только с *Runner Hands* - `Beatrun_QuickturnHandsOnly`.
* Небольшой толчок камеры при нырянии.
* SteamID больше не видно на экране.
## Исправления
* Отображение моделей как **ERROR**.
* Сортировка таблицы лидеров.
* Использование крюка-кошки в режимах.
* Краш в Data Theft при касании с Data Bank.
* Ошибки с коллиизей - урон в PvP не проходил, если режим не Data Theft.
* Возможность прыгать во время ходьбы (🤷).
* Подправлен кувырок - можно кувыркаться под объектами.
* Подправлена крюк-кошка - движется с объектом к которому прикреплена и видна другим игрокам.
## TODO
* [ ] Меню создания снаряжений для Deathmatch/Data Theft.
* Некоторые модельки игрока отображались как ERROR от первого лица.
* Сортировка таблиц лидеров в режимах.
* Использование крюка-кошки в режимах и курсах.
* Краш игры в режиме Data Theft при использовании Data Bank.
* Урон между игроками проходил только в Data Theft.
* Разрешены прыжки при ходьбе.
* Возможность переката **под** объектами.
* Крюк-кошка теперь следует за объектом к которому она присоединена, так же её видят другие игроки.
## Известные проблемы
* [Тут](https://github.com/JonnyBro/beatrun/issues).
* Может ещё чего, я не помню 💀.
* [Проблемы](https://github.com/JonnyBro/beatrun/issues).
## Связанные проекты
* [Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims).
* [Проект Beatrun Reanimated](https://github.com/JonnyBro/beatrun-anims).
## Благодарности
* [Все участники](https://github.com/JonnyBro/beatrun/graphs/contributors) - <3.
* [EarthyKiller127](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - Создатель этого ужаса.
* [relaxtakenotes](https://github.com/relaxtakenotes) - Без него этого проекта бы не существовало.
* [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.
* [EarthyKiller127/datae](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - Создатель оригинального Beatrun.
* [relaxtakenotes](https://github.com/relaxtakenotes) - Без него этот проект не существовал бы.
* [MTB](https://www.youtube.com/@MTB396) - Проект Beatrun Reanimated.
* [Fluffy Servers](https://github.com/fluffy-servers/gmod-discord-rpc) - Модуль показа статусов в Discord.
* [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) - Модуль показа статусов в Steam (создатель TFA Base!).