Skip to content

Commit

Permalink
[skip ci] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
s1lentq committed Jun 20, 2024
1 parent 8ab6ca3 commit c3dddd0
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Reunion [![C/C++ CI](https://github.com/s1lentq/reunion/actions/workflows/build.yml/badge.svg)](https://github.com/s1lentq/reunion/actions/workflows/build.yml) [![GitHub release (by tag)](https://img.shields.io/github/downloads/s1lentq/reunion/latest/total)](https://github.com/s1lentq/reunion/releases/latest) ![GitHub all releases](https://img.shields.io/github/downloads/s1lentq/reunion/total) [![Percentage of issues still open](http://isitmaintained.com/badge/open/s1lentq/reunion.svg)](http://isitmaintained.com/project/s1lentq/reunion "Percentage of issues still open") [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](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)
Expand All @@ -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.

Expand All @@ -41,31 +41,33 @@ 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.

* `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.
Expand Down Expand Up @@ -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

0 comments on commit c3dddd0

Please sign in to comment.