Compare commits

...

2 commits

Author SHA1 Message Date
5763b06db1
replace added with features 2024-04-07 17:29:11 +05:00
d88bd2d580
rewrite READMEs 2024-04-07 17:23:07 +05:00
4 changed files with 134 additions and 118 deletions

View file

@ -3,7 +3,7 @@
## Animations Installer Source Code ## Animations Installer Source Code
Here you can find source code of the animations installer.\ Here you can find source code of the animations installer.\
I don't know why you will ever need that but we put it here so you can be sure we don't supply malware with our fork. I don't know why you will ever need that but we put it here so you can be sure we don't supply malware with our project.
## How To Use ## How To Use
@ -19,7 +19,7 @@ Please refer to this [README](../beatrun/README.md).
## Исходный код установщика анимаций ## Исходный код установщика анимаций
Здесь находятся исходники нашего установщика анимаций.\ Здесь находятся исходники нашего установщика анимаций.\
Я не знаю зачем это вам, но мы оставили их здесь чтобы вы могли убедиться что мы не распространяем вирусы в нашем форке. Я не знаю зачем это вам надо, но мы оставили их здесь чтобы вы могли убедиться что мы не распространяем вирусы в нашем проекте.
## Как использовать ## Как использовать

102
README.md
View file

@ -2,92 +2,100 @@
* [Русский](./README_ru.md) * [Русский](./README_ru.md)
Infamous parkour addon for Garry's Mod, fully open sourced and maintained by the community (me 😞). **PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS ON OUR SERVER!**\
**WE DOCUMENTED EVERYTHING ENOUGH SO YOU CAN INSTALL THIS YOURSELF PRETTY EASILY**
Infamous parkour addon for Garry's Mod.\
Fully open sourced and maintained by the community (me 😞).
> [!IMPORTANT] > [!IMPORTANT]
> You will not find here any malicious modules, code or networking! We have modules and networking for: > This repository doesn't contain any malicious modules. It does contain some modules for additional functionality like:
> >
> * Discord Rich Presence. > * Discord Rich Presence.
> * Steam Presence. > * Steam Presence.
> * Custom Courses Database.
> >
> **All of this is optional and you can remove all of it.**\ > **They are optional and can be removed at any time.**\
> Modules are located [here](https://github.com/JonnyBro/beatrun/tree/main/lua/bin) and courses database functionality is [here](https://github.com/JonnyBro/beatrun/blob/main/beatrun/gamemodes/beatrun/gamemode/cl/CoursesDatabase.lua).\ > You can find all modules **[here](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
> You can find source code for modules in [Credits](#credits) section. > Check **[Credits](#credits)** section for their source code.
**PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS ON OUR SERVER!** ## Automatic Installation (Recommended | Windows 10/11)
## Automatic Installation (Recommended | Windows only) > [!WARNING]
> Windows 7 is not supported.\
> Update already...
Run the command below in Powershell. Run the command below in Powershell.
> [!NOTE] > [!NOTE]
> Win + R > `powershell` > Win + R > `powershell` > *Enter*
```powershell ```powershell
iex (iwr "beatrun.ru/install" -UseBasicParsing) iex (iwr "beatrun.ru/install" -UseBasicParsing)
``` ```
Select the `Beatrun` gamemode in right lower corner. * Select the `Beatrun` gamemode in right lower corner.
## Manual Installation ## Manual Installation
1. Download this repository [here](https://github.com/JonnyBro/beatrun/archive/refs/heads/master.zip). 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.** 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*. 3. Extract the `beatrun-main/beatrun` folder to *your_game_folder/garrysmod/addons*.
4. Extract the `beatrun-main/lua` folder to *your_game_folder/garrysmod*. 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. 5. Select the `Beatrun` gamemode in right lower corner.
## Animations ## Animations
Please refer to this [README](beatrun/README.md). [Please refer to this file.](beatrun/README.md)
## Changes ## Features
> [!IMPORTANT] > [!IMPORTANT]
> There are many undocumented changes and fixes in this version, you better look at the commits for more specific changes. > 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 online courses database](https://courses.beatrun.ru), which is also free and [open source](https://github.com/relaxtakenotes/beatrun-courses-server/) 🤯! * Jonny_Bro is hosting **[custom courses database](https://courses.beatrun.ru)**, which is also **free** to use and **[open sourced](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-express)**!
* Implemented a new gamemode - **Deathmatch** (it's way more fun than Data Theft I promise). * New gamemode - **Deathmatch** (it's way more fun than Data Theft I promise).
* Implemented "Proper" Kick Glitch just like in [original ME](https://www.youtube.com/watch?v=zK5y3NBUStc). * "Proper" Kick Glitch just like in **[original game](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
* Added an in-game config menu - you can find it in the tool 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. **All** of the Beatrun settings can be changed in the configuration menu!
* Discord and Steam Presence.
* Localization support.\ * Localization support.\
Available in 5 languages now! Available in 5 languages now!
* Build Mode Tweaks.\ * Build Mode Tweaks.\
You can now spawn any prop from Spawn Menu and they will save in course. You can now spawn any prop from Spawn Menu and they will save in your course.
* Added the ability to get off of ladders. * Ability to get off of ladders - Press CTRL.
* Added an arrow that shows the next checkpoint. * Ability to remove ziplines that created with *Zipline Gun* - Press RMB.
* Added a ConVar to allow Overdrive usage on the server - `Beatrun_AllowOverdriveInMultiplayer`. * Arrow that shows the next checkpoint.
* Added a ConVar to toggle between old and new Kick Glitch - `Beatrun_OldKickGlitch`. * ConVar to allow Overdrive usage (server) - `Beatrun_AllowOverdriveInMultiplayer`.
* Added some ConVars to change HUD colors - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`. * ConVar to allow players to spawn props and weapons without admin rights (server) - `Beatrun_AllowPropSpawn`.
* Added a ConVar to allow players to spawn props and weapons without admin rights - `Beatrun_AllowPropSpawn`. * ConVar to toggle the heatlh regeneration (server) - `Beatrun_HealthRegen`.
* Added a ConVar to toggle the grapple ability - `Beatrun_DisableGrapple`. * ConVars to change HUD colors (client) - `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`.
* Added a ConVar to allow QuickTurn with any weapon or only with *Runner Hands* - `Beatrun_QuickturnHandsOnly`. * ConVar to toggle the grapple ability (client) - `Beatrun_DisableGrapple`.
* Added a ConVar to toggle the heatlh regeneration - `Beatrun_HealthRegen`. * ConVar to toggle between old and new Kick Glitch (client) - `Beatrun_OldKickGlitch`.
* Added small camera punch when diving. * ConVar to allow QuickTurn with any weapon or only with *Runner Hands* (client) - `Beatrun_QuickturnHandsOnly`.
* Added the ability to remove ziplines that created with *Zipline Gun* - `RMB`. * Small camera punch when diving.
* Implemented Discord Rich Presence using [open source](#credits) module. * Your SteamID on the screen is no longer present.
## Fixes ## Fixes
* Your SteamID in the right corner is no longer present. * Some playermodels show up as **ERROR**.
* Fixed some playermodels show up as ERROR. * Leaderboard sorting in gamemodes.
* Done various tweaks to the Courses Menu (F4). * 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 (🤷). * Allowed jumping while walking (🤷).
* Fixed leaderboard sorting in gamemodes. * Tweaked safety roll - now you can roll under things.
* Fixed grapple usage in courses and gamemodes. * Tweaked some grapple related stuff - now it moves with the entity it was attached to and other players can see the rope.
* Fixed a crash in Data Theft when touching Data Bank.
* Fixed an error on course loading.
* Fixed collisions issues. (PvP damage not going through in gamemodes other than Data Theft)
* 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.
* Made it possible to dive to your death =).
## TODO ## 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. (idk how to properly implement this for know).
## Related ## Known issues
* [Issues](https://github.com/JonnyBro/beatrun/issues).
* Maybe more, i forgor 💀.
## Related projects
* [Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims). * [Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims).
@ -97,5 +105,5 @@ You can now spawn any prop from Spawn Menu and they will save in course.
* [EarthyKiller127](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit. * [EarthyKiller127](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - He made that piece of shit.
* [relaxtakenotes](https://github.com/relaxtakenotes) - Made all of this possible. * [relaxtakenotes](https://github.com/relaxtakenotes) - Made all of this possible.
* [MTB](https://www.youtube.com/@MTB396) - Beatrun Reanimated Project. * [MTB](https://www.youtube.com/@MTB396) - Beatrun Reanimated Project.
* [Discord Rich Presence](https://github.com/fluffy-servers/gmod-discord-rpc) by Fluffy Servers. * [Fluffy Servers](https://github.com/fluffy-servers/gmod-discord-rpc) - Discord Rich Presence.
* [Steam Presence](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) by YuRaNnNzZZ. * [YuRaNnNzZZ](https://github.com/YuRaNnNzZZ/gmcl_steamrichpresencer) - Steam Presence.

View file

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

View file

@ -2,10 +2,10 @@
## Animations Installer ## Animations Installer
You can use **BeatrunAnimInstaller** (located literally here) to change animations. Currently we have: You can use **BeatrunAnimInstaller** (located here) to change animations. Currently we have:
1. `Beatrun Reanimated Project` animations. * Beatrun Reanimated Project.
2. Original but fixed animations. * Original but fixed animations.
## How To Use ## How To Use
@ -13,7 +13,7 @@ You can use **BeatrunAnimInstaller** (located literally here) to change animatio
2. Press a key on your keyboard with the number of the animation you want to install. 2. Press a key on your keyboard with the number of the animation you want to install.
> [!NOTE] > [!NOTE]
> If nothing is changed, close the game and/or try run the program with admin priveleges. > If nothing is changed, close the game and try run the program with admin priveleges.
## Source Code ## Source Code
@ -24,10 +24,10 @@ Please refer to this [README](../BeatrunAnimInstaller_Source/README.md).
## Установщик анимаций ## Установщик анимаций
Используйте **BeatrunAnimInstaller** (который расположен прямо тут) чтобы менять анимации. На данный момент у нас имеются: Используйте **BeatrunAnimInstaller** (расположен прямо тут) чтобы менять анимации. На данный момент у нас имеются:
1. Анимации из `Beatrun Reanimated Project`. * Beatrun Reanimated Project.
2. Оригинальные анимации с правками и фиксами. * Починенные оригинальные анимации.
## Как использовать ## Как использовать
@ -35,7 +35,7 @@ Please refer to this [README](../BeatrunAnimInstaller_Source/README.md).
2. Нажмите цифру желаемых анимаций на клавиатуре. 2. Нажмите цифру желаемых анимаций на клавиатуре.
> [!NOTE] > [!NOTE]
> Если ничего не изменилось, закройте игру и/или запустите файл от имени администратора. > Если ничего не изменилось, закройте игру и запустите файл от имени администратора.
## Исходный код ## Исходный код