rewrite READMEs again (yipee)

This commit is contained in:
Jonny_Bro (Nikita) 2024-11-30 21:21:50 +05:00
parent 4467097586
commit 6472e0af42
3 changed files with 192 additions and 159 deletions

175
README.md
View file

@ -1,110 +1,125 @@
# Beatrun | Community edition
# Beatrun | Community Edition
[![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)
[![Powered by Electricity](https://forthebadge.com/images/featured/featured-powered-by-electricity.svg)](https://forthebadge.com)
[![Powered by Black Magic](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com)
[Click to join our Discord!](https://discord.gg/93Psubbgsg)
[**Join our Discord Community!**](https://discord.gg/93Psubbgsg)
* [Русский](./README.ru.md)
> *[Русский | Russian](./README.ru.md)*
**PLEASE READ EVERYTHING BEFORE ASKING QUESTIONS!**
---
Infamous parkour addon for Garry's Mod. Fully open sourced and maintained by the community (me 😞).
## 🚨 Important Notice
> [!IMPORTANT]
> This repository doesn't contain any malicious modules. However, we have some modules for additional functionality:
>
> * Discord Rich Presence.
> * Steam Presence.
>
> **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.
### Please read this README thoroughly before asking questions
## Automatic Installation (Recommended | Windows 10/11)
### The **only official source** for this fork is this GitHub repository. Workshop versions are outdated and unsupported
---
## About
Beatrun is an **infamous parkour addon for Garry's Mod**, now fully open-sourced and maintained by the community.
It includes various improvements, new features, and enhanced functionality.
> [!WARNING]
> Windows 7 and old versions of Windows 10 are not supported.\
> Please update.
> **This repository contains no malicious modules.** However, optional modules such as Discord Rich Presence and Steam Presence are available for additional features.
> These are **completely optional** and can be removed at any time.
>
> - Modules are located **[here](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.
> - Refer to the **[Credits](#credits)** section for their source code.
---
## Installation
### 🔧 Automatic Installation (Recommended for Windows 10/11)
Run the command below in Powershell (run as admin if your Steam or game located in a C: drive).
> [!NOTE]
> Win + R > `powershell` > *Enter*
> Windows 7 and old versions of Windows 10 are not supported. Please update your OS.
Run the following command in PowerShell (Run as Administrator if Steam and/or the game is installed on the system (C:) drive):
```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)**.
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*.
1. Start the game.
1. Select the `Beatrun` gamemode in right lower corner.
2. Select the `Beatrun` gamemode in the bottom-right 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 it exists.
3. Extract `beatrun-main/beatrun` into `your_game_folder/garrysmod/addons`.
4. (Optional) For Discord and Steam Presence, extract `beatrun-main/lua` to `your_game_folder/garrysmod`.
5. Start the game.
6. Select the `Beatrun` gamemode in the bottom-right corner.
---
## Features and Updates
### New Features
- **Custom Courses Database** hosted by Jonny_Bro: **[Access Here](https://courses.jonnybro.ru)** (free and **[open source](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-docker)**).
- **New Gamemode:** Deathmatch.
- "Proper" Kick Glitch similar to the **[original game](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
- In-game configuration menu in the Tools menu under **Beatrun**. All settings can be modified here.
- Localization support in **7 languages**.
- Enhanced Build Mode: spawn props from the Spawn Menu, and they will save in your course.
- Various new 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).
- **Next checkpoint arrow** for easier navigation.
- New server and client configuration variables:
- Server:
- `Beatrun_AllowOverdriveInMultiplayer`: Allows Overdrive in multiplayer.
- `Beatrun_AllowPropSpawn`: Lets players spawn props and weapons without admin rights.
- `Beatrun_HealthRegen`: Toggles health regeneration.
- Client:
- `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor`: Customize HUD colors.
- `Beatrun_DisableGrapple`: Toggle the grapple ability.
- `Beatrun_OldKickGlitch`: Switch between old and new Kick Glitch.
- `Beatrun_QuickturnHandsOnly`: Restrict QuickTurn to the Runner Hands weapon.
- Other improvements:
- Small camera punch effect when diving.
- SteamID no longer displayed on 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.
- Grapples now follow moving entities and are visible to other players.
---
## Animations
Animations installer was removed, now you can switch between animations in Tools menu in Beatrun category.
The animations installer has been removed. You can now switch animations directly in the **Tools menu** under the Beatrun category.
## What's new
---
> [!IMPORTANT]
> There are many undocumented changes and fixes in this version, you better look at the commits for more specific changes.
## Known Issues
* 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.\
**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).
* 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.
* 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.
* SteamID is no longer shown on screen.
- See the full list of issues **[here](https://github.com/JonnyBro/beatrun/issues)**.
## Fixes
---
* 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.
* 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.
## Related Projects
## Known issues
- **[Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims)**
* [Issues](https://github.com/JonnyBro/beatrun/issues).
## Related projects
* [Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims).
---
## Credits
* [All contributors](https://github.com/JonnyBro/beatrun/graphs/contributors) - <3.
* [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 (TFA Base creator!).
- **[All contributors](https://github.com/JonnyBro/beatrun/graphs/contributors)** ❤️
- [EarthyKiller127/datae](https://www.youtube.com/channel/UCiFqPwGo4x0J65xafIaECDQ) - Original creator of Beatrun.
- [relaxtakenotes](https://github.com/relaxtakenotes) - Made this project 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 (TFA Base creator).

View file

@ -1,110 +1,127 @@
# Beatrun | Community edition
# Beatrun | Community Edition
[![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)
[![Powered by Electricity](https://forthebadge.com/images/featured/featured-powered-by-electricity.svg)](https://forthebadge.com)
[![Powered by Black Magic](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)
> *[English | Английский](./README.md)*
**ПОЖАЛУЙСТА, ПРОЧИТАЙТЕ ВЕСЬ ДОКУМЕНТ ПЕРЕД ТЕМ КАК ЗАДАВАТЬ ВОПРОСЫ!**
---
Печально известный паркур аддон для Garry's Mod. Теперь, с полностью открытым исходным кодом и поддерживаемый сообществом (мной 😞).
## 🚨 Важное уведомление
> [!IMPORTANT]
> Данный репозиторий не содержит вредоносных модулей. Однако, мы имеем несколько модулей для дополнительного функционала:
>
> * Модуль для показа статуса в Discord.
> * Модуль для показа статуса в Steam.
>
> **Они не обязательны и могут быть удалены в любой момент.**\
> Список всех модуйлей находится **[здесь](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.\
> Проверьте **[Благодарности](#благодарности)** чтобы найти их исходный код.
### Пожалуйста, прочитайте этот README полностью перед тем, как задавать вопросы.
## Автоматическая установка (Рекомендуется | Windows 10/11)
### **Единственный официальный источник** этого форка — этот репозиторий на GitHub. Версии в Workshop устарели и не поддерживаются.
---
## О проекте
Beatrun — это **знаменитый паркур-аддон для Garry's Mod**, теперь с полностью открытым исходным кодом и поддерживаемый сообществом.
Включает различные улучшения, новые функции и расширенную функциональность.
> [!WARNING]
> Windows 7 и старые сборки Windows 10 не поддерживаются.
> Обновитесь, пожалуйста.
> **В этом репозитории нет вредоносных модулей.** Однако доступны опциональные модули, такие как показ статусов в Discord и Steam, для дополнительного функционала.
> Эти модули **абсолютно опциональны** и могут быть удалены в любое время.
>
> - Модули находятся **[здесь](https://github.com/JonnyBro/beatrun/tree/main/lua/bin)**.
> - Ознакомьтесь с разделом **[Благодарности](#credits)** для их исходного кода.
---
## Установка
### 🔧 Автоматическая установка (Рекомендуется для Windows 10/11)
Запустите команду ниже в Powershell (запустите от администратора если Steam или игра расположены на диске C:).
> [!NOTE]
> Win + R > `powershell` > *Enter*
> Windows 7 и старые версии Windows 10 не поддерживаются. Обновите свою ОС.
Запустите данную команду в PowerShell (Запустите от админа если Steam и/или игра установлены на системный (C:) диск):
```powershell
irm https://beatrun.jonnybro.ru/install | iex
```
* Запустить игру.
* Выбрать режим `Beatrun` в правом нижнем углу.
1. Запустите игру.
2. Выберите режим `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` в правом нижнем углу.
2. Удалите папку `beatrun` в `путь_к_игре/garrysmod/addons`, если она существует.
3. Извлеките `beatrun-main/beatrun` в `путь_к_игре/garrysmod/addons`.
4. *(Опционально)* Для показа статусов в Discord и Steam извлеките `beatrun-main/lua` в `путь_к_игре/garrysmod`.
5. Запустите игру.
6. Выберите режим `Beatrun` в правом нижнем углу.
---
## Особенности и обновления
### Новые возможности
- **База курсов** от Jonny_Bro: **[Доступна здесь](https://courses.jonnybro.ru)** (бесплатна и имеет **[открытый исходный код](https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-docker)**).
- **Новый режим:** Deathmatch.
- Полностью исправленный Kick Glitch, как в **[оригинальной игре](https://www.youtube.com/watch?v=zK5y3NBUStc)**.
- Меню настроек в игре в категории **Beatrun** в меню Инструментов.
Здесь можно настроить **все** параметры Beatrun.
- Поддержка локализации на **7 языках**.
- Улучшенный режим строительства курсов:
Пропы из меню спавна сохраняются в вашем курсе.
- Новые способности:
- **Перекат после зиплайнов:** Нажмите `CTRL`.
- **Слезание с лестниц:** Нажмите `CTRL`.
- **Удаление зиплайнов:** Нажмите ПКМ (`RMB`).
- **Указатель следующего чекпоинта** для облегчения навигации.
- Новые серверные и клиентские переменные:
- Серверные:
- `Beatrun_AllowOverdriveInMultiplayer` — разрешает Overdrive в мультиплеере.
- `Beatrun_AllowPropSpawn` — разрешает спавн пропов и оружия без прав администратора.
- `Beatrun_HealthRegen` — переключает регенерацию здоровья.
- Клиентские:
- `Beatrun_HUDTextColor`, `Beatrun_HUDCornerColor`, `Beatrun_HUDFloatingXPColor` — настройка цветов интерфейса.
- `Beatrun_DisableGrapple` — включение/выключение крюка-кошки.
- `Beatrun_OldKickGlitch` — переключение между старым и новым Kick Glitch.
- `Beatrun_QuickturnHandsOnly` — ограничение QuickTurn только для оружия Runner Hands.
- Прочие улучшения:
- Лёгкий толчок камеры при нырянии.
- SteamID больше не отображается на экране.
### Исправления
- Исправлено отображение моделей игроков как `ERROR` от первого лица.
- Улучшена сортировка таблиц лидеров в режимах.
- Исправлены краши и баги в режиме Data Theft.
- Включены прыжки при ходьбе.
- Крюк-кошка теперь следует за перемещаемыми объектами и видна другим игрокам.
---
## Анимации
Установщик анимаций был удалён, теперь анимации можно переключить в меню Инструментов в категории Beatrun.
Установщик анимаций удалён. Теперь их можно переключать в **меню Инструментов** в категории Beatrun.
## Отличия от оригинала
> [!IMPORTANT]
> Множество изменений не задокументированы, проверьте коммиты для полного списка изменений.
* 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.
* Урон между игроками проходил только в Data Theft.
* Разрешены прыжки при ходьбе.
* Возможность переката **под** объектами.
* Крюк-кошка теперь следует за объектом к которому она присоединена, так же её видят другие игроки.
---
## Известные проблемы
* [Проблемы](https://github.com/JonnyBro/beatrun/issues).
- Полный список доступен **[здесь](https://github.com/JonnyBro/beatrun/issues)**.
---
## Связанные проекты
* [Проект Beatrun Reanimated](https://github.com/JonnyBro/beatrun-anims).
- **[Beatrun Reanimated Project](https://github.com/JonnyBro/beatrun-anims)**
---
## Благодарности
* [Все участники](https://github.com/JonnyBro/beatrun/graphs/contributors) - <3.
* [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!).
- **[Все участники](https://github.com/JonnyBro/beatrun/graphs/contributors)** ❤️
- [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).

View file

@ -54,7 +54,8 @@ local incompatible = {
["748422181"] = true, -- FOV Changer
["2930331275"] = true, -- Realistic Fragmentation System
["112806637"] = true, -- Gmod Legs 3
["678037029"] = true -- Enhanced Camera
["678037029"] = true, -- Enhanced Camera
["2497150824"] = true -- Smooth Camera
}
local warnpanel = {