Skip to content

Commit

Permalink
add documentation, to fix workbench debugger configuration under linux
Browse files Browse the repository at this point in the history
  • Loading branch information
svencc committed Nov 17, 2024
1 parent b8d75e8 commit ebf5184
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/concept/Connection-Bootstrap.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
@startuml
'https://plantuml.com/sequence-diagram

header Message Bus
title Bootstrapping the Client <-> Server Connection

autonumber

CLIENT -> SERVER: Authenticate
CLIENT <-- SERVER: Send Token

CLIENT -> SERVER: Heartbeat
SERVER --> SERVER: Register-Client/Keep-Client-Alive
note right
register client and mark alive for x seconds
if no hearbeat arrives after x seconds, mark client as dead
end note

SERVER --> SERVER: create messages for client (with ID)

CLIENT -> SERVER: Request Messages since {time} for {ID}
CLIENT <-- SERVER: Response with latest messages after requested time for client-ID
note right
serve from buffer
end note




@enduml
Binary file added docs/setup/debugger-port.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/setup/first run.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@
~/Dokumente/Code/IdeaProjects/ReforgerCommanderClient/ \
~/snap/steam/common/.local/share/Steam/steamapps/compatdata/1874910/pfx/drive_c/users/steamuser/My\ Documents/My\ Games/ArmaReforgerWorkbench/addons/RECOMClient

# ARMA REFORGER WORKBENCH:
## Redirecting Network Traffic
- as the workbench debugger works on port 1000 per default, and linux processes are not allowed to listen in ports 0-1000 (only under special circumstances), we have to set the port to a higher number.
- therefore we have to add an argument -debuggerPort <port> to the workbench/steam start command:
![debugger-port](debugger-port.png)
- To tell the Reforger Script Editor to use the new port, we have to set the port in the Workbench also:
![script-editor-debugger](script-editor-debugger.png)
- You can also check if network packets are sent to this port:
- sudo tcpdump -i lo port <port>>

## profile
- set the authentication_properties.json in the ReforgerWorkbench profile/RECOM folder:
- The file+folder /RECOM/authentication_properties.json should be create automatically by the RECOMClient mod when starting the game (with DEFAULT configuration values).
Expand Down
Binary file added docs/setup/script-editor-debugger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ebf5184

Please sign in to comment.