From c3dddd0bf4925b458be3805c78c8e1af55bb2af7 Mon Sep 17 00:00:00 2001
From: s1lentq <s1lentsk@yandex.ru>
Date: Fri, 21 Jun 2024 00:16:30 +0700
Subject: [PATCH] [skip ci] Update README.md
---
README.md | 36 +++++++++++++++++++-----------------
1 file changed, 19 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index d22d96e..808a88b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Reunion [](https://github.com/s1lentq/reunion/actions/workflows/build.yml) [](https://github.com/s1lentq/reunion/releases/latest)  [](http://isitmaintained.com/project/s1lentq/reunion "Percentage of issues still open") [](https://www.gnu.org/licenses/gpl-3.0)
-Metamod plugin that allows protocol 47 and 48 no-steam clients to connect to ReHLDS servers.<br/>
+Metamod plugin that allows protocol 47 and 48 non-steam clients to connect to ReHLDS servers.<br/>
Reunion is a continuation of the DProto project adapted for ReHLDS.<br/>
You can try playing on one of many servers that are using Reunion: [Game Tracker](http://www.gametracker.com/search/?search_by=server_variable&search_by2=reu_version)
@@ -10,24 +10,24 @@ You can try playing on one of many servers that are using Reunion: [Game Tracker
* [Dev builds](https://github.com/s1lentq/reunion/actions/workflows/build.yml)
## Environment requirement
-* ReHLDS API >= 3.10
+* ReHLDS API >= `3.10`
## Installation
<details>
<summary>Click to expand</summary>
-1. Go to `<gamedir>/addons/` and make new directory named reunion<br/>
-`<gamedir>` - its a game directory; cstrike for Counter-Strike, valve for Half-Life, etc
+1. Go to `<gamedir>/addons/` and make new directory named `reunion`<br/>
+`<gamedir>` - its a game directory (cstrike for Counter-Strike, valve for Half-Life, etc)
-2. Copy `reunion_mm.dll` or `reunion_mm_i386.so` to <gamedir>/addons/reunion/
+2. Copy `reunion_mm.dll` or `reunion_mm_i386.so` to `<gamedir>/addons/reunion/`
-3. Go to metamod installation directory (usually its <gamedir>/addons/metamod/) and edit plugins.ini:<br/>
-add this line for windows<br/>
+3. Go to metamod installation directory (usually its `<gamedir>/addons/metamod/`) and edit `plugins.ini`:<br/>
+add this line at the beginning of the file<br/>
+for windows<br/>
`win32 addons\reunion\reunion_mm.dll`<br/>
-or this for linux<br/>
+for linux<br/>
`linux addons/reunion/reunion_mm_i386.so`<br/>
-at the beginning of the file<br/>
4. Copy `reunion.cfg` to server root or gamedir.
@@ -41,23 +41,25 @@ at the beginning of the file<br/>
```
6. Ready to use
-If reunion doesn't work, meta list says this:
+If reunion doesn't work, meta list says this:<br/>
+```
Currently loaded plugins:
description stat pend file vers src load unlod
[ 1] Reunion fail load reunion_mm_i386. v0.1.65 ini Start Never
-
-Start server with `-console +log on +mp_logecho 1` parameters and look through console output. You'll find the reason there.
+```
+Start server with `-console +log on +mp_logecho 1` parameters and look through console output.<br/>
+You'll find the reason there.
</details>
## FAQ
<details>
<summary>Click to expand</summary>
-* `Q` I configured SteamIdHashSalt as well as in the dproto, but players get a different steamids. Why?<br/>
- `A` Reunion uses an another hashing algorythm with improved security. Knowing of someones's steamid before enabling SteamIdHashSalt doesn't help to get same id after hashing.
+* `Q` I configured `SteamIdHashSalt` as well as in the dproto, but players get a different steamids. Why?<br/>
+ `A` Reunion uses an another hashing algorythm with improved security. Knowing of someones's steamid before enabling `SteamIdHashSalt` doesn't help to get same id after hashing.
* `Q` Is it possible to do something against steamid changers?<br/>
- `A` No, idchangers generates a correct authorization tickets and it's impossible on serverside identify that steamid was changed. You can only set a SteamIdHashSalt option to prevent a substitution to specific steamid of another player.
+ `A` No, idchangers generates a correct authorization tickets and it's impossible on serverside identify that steamid was changed. You can only set a `SteamIdHashSalt` option to prevent a substitution to specific steamid of another player.
* `Q` Why some server monitorings can't receive the players list from server?<br/>
`A` They use an incorrect query format and must be rewritten using latest <a href="https://github.com/xPaw/PHP-Source-Query">PHP-Source-Query</a> script or equivalent.
@@ -65,7 +67,7 @@ Start server with `-console +log on +mp_logecho 1` parameters and look through c
* `Q` In dproto was option Game_Name, but in reunion it has not. How to change the game name?<br/>
`A` Use plugin.
-* `Q` Why has SmartSteamEmu3 support been removed?<br/>
+* `Q` Why has `SmartSteamEmu3` support been removed?<br/>
`A` To open-source the Reunion project, we had to remove some sensitive components.<br/>
This includes the `SmartSteamEmu3` emulator's authorization code.
Removing it won't significantly affect server online activity since this emulator is rare among non-steam clients.
@@ -140,7 +142,7 @@ Select the preferred C/C++ Compiler installation
### Credits
* [@Crock](https://github.com/theCrock), [@Lev](https://github.com/LevShisterov), and other people such as [@PRoSToTeM@](https://github.com/WPMGPRoSToTeMa) who participated or helped with the development of [DProto](https://cs.rin.ru/forum/viewtopic.php?f=29&t=55986)
-* [@theAsmodai](https://github.com/theAsmodai) for contributions as Reunion project former maintainer
+* [@Asmodai](https://github.com/theAsmodai) for contributions as Reunion project former maintainer
* [@dreamstalker](https://github.com/dreamstalker) for the rehlds project, as well as the contributors involved in this project
* [@NordicWarrior](https://github.com/Nord1cWarr1or) for testing and feedback
* [@kazakh758](https://github.com/kazakh758) for testing a fix of issue related to the client hanging on connect