Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tremwil committed May 11, 2021
1 parent 07fd86e commit eb709f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
1 change: 0 additions & 1 deletion DS3ConnectionInfo/MainWindow.xaml.cs
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,6 @@ private void DarkSouls_HasExited(object sender, EventArgs e)
{
updateTimer.Stop();
SteamAPI.Shutdown();
File.Delete("steam_appid.txt");
Close();
}

Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# DS3ConnectionInfo
Simple C# application showing active P2P connection information along ping and geolocation for Dark Souls III. In a game whose PvP is highly dependent on spacing and timing, knowing the latency between you and your opponent before the fight can be pretty useful. Also implements an in game overlay (**windowed or borderless windowed mode only**) and a simple ping filter (it has many limitations, see FAQ for more information).
### Known Bugs (will be fixed in V4.1):
- Overlay does not shrink to fit contents after expanding

## [Download](https://github.com/tremwil/DS3ConnectionInfo/releases/download/V4/DS3ConnectionInfo-V4.0.zip)
## [Download](https://github.com/tremwil/DS3ConnectionInfo/releases/download/V4.1/DS3ConnectionInfo-V4.1.zip)

## DISCLAIMER:
**Do not share the location information provided by this program. While you should be free to view it yourself since the players are connected to your computer, respect the privacy of others. I am not responsible for any misuse of this information.**
Expand All @@ -20,11 +18,9 @@ Download the lastest release from the Releases tab and extract the ZIP file in a
It is 100% ban-safe, as the program does not modify the game's original code in any way. The program does allocate new memory in the Dark Souls III process to execute in-game functions (eg. query an invasion), however, but this does not cause bans.

### How does the ping filter work?
The ping filter is very basic. When it is enabled and one invades or places a red/white sign using the program's hotkeys, the program will wait until an online session begins. After the connection with all players is established, the program will wait "Filter Delay" seconds and then compute the average ping of every player in the lobby. If this value is higher than the threshold, the online session will be abandonned and your invasion request / summon sign will reset. While this works fairly
well in practice, it has some disadvantages:
- Since it is impossible to know the team of a player before the loading screen, the connection to a friendly player will affect matchmaking.
- It is still possible to connect to unacceptably laggy players, if others in the session have a good ping. I am aware of this, and will add an absolute ping threshold in the future. I didn't add one because I thought it would reduce online acitivty too much.
- The ping filter is useless for hosts. **This is by design**. I did not want to implement any kind of targeted kick functionality into the program, especially since it is open source.
The ping filter is very basic. It trigger when one attemps to join an online session (either through covenant invasions or summon signs). After the connection with all players is established, the program will wait "Filter Delay" seconds and then compute the average ping of every player in the lobby. If this value is higher than the maximum average threshold or the ping of a single player is higher than the maximum absolute threshold, the online session will be abandonned and your invasion request / summon sign will reset. While this works fairly well in practice, it has some disadvantages:
- Since it is impossible to know the team of a player before the loading screen, the connection to a friendly player will affect matchmaking.
- It is still possible to connect to unacceptably laggy players, if they join the online session after the player using the ping filter. For the same reason, this ping filter is useless for hosts. **This is by design**. I did not want to implement any kind of targeted kick functionality into the program, especially since it is open source.

### Are the pings shown accurate if the other player is using a VPN?
**Yes**, if V2+ is used. Since the pings are not calculated by pinging the remote IP but rather by listening for STUN reply packets coming from the remote game, using a VPN will not show an incorrect ping. The location information, however, does use the remote IP, and can be hidden using a VPN.
Expand Down

0 comments on commit eb709f2

Please sign in to comment.