v2.0

Author: MXWXZ

.gitignore

@@ -27,7 +27,6 @@ qrc_*.cpp
 ui_*.h
 *.qmlc
 *.jsc
-Makefile*
 *build-*
 *.qm
 *.prl

README.md

@@ -1,10 +1,14 @@
 # civrip
+**100% open source**
+
 GUI to create virtual network for civilization 6 and old school games in multiplayer mode.
 
 简单GUI为文明6及老游戏联机提供虚拟组网。
 
 [中文Readme](README_zh_CN.md)
 
+![main](./assets/main_en.png)
+
 ## Motivation
 Civilization 6 and other old school games only support LAN for multiplayer (if you cannot connect to Civilization 6 official server). The most common way is to create a virtual network to simulate a LAN.
 
@@ -13,7 +17,9 @@ Possible solution:
 - [n2n](https://github.com/ntop/n2n): Similar to Zerotier, but it needs a coordinator server to connect different users and forwarding traffic (if P2P is disabled). It allows the user to force TCP connection instead of UDP.
 - VPN: Also work for most cases, but it is too heavy and not allowed in some network environment.
 
-Civilization 6 has another problem that it only scan the default NIC for local rooms, but most solutions based on virtual NIC. We need [WinIPBroadcast](https://github.com/dechamps/WinIPBroadcast) to send IP broadcast packets to all interfaces.
+~~Civilization 6 has another problem that it only scan the default NIC for local rooms, but most solutions based on virtual NIC. We need [WinIPBroadcast](https://github.com/dechamps/WinIPBroadcast) to send IP broadcast packets to all interfaces.~~
+
+Update: Inspired by @xaxys (https://github.com/xaxys/injciv6/tree/master), we now have a newer solution through function hook. 
 
 I developed this tool to automate the process for Civilization 6 multiplayer mode (and old school games), based on n2n to overcome network issues.
 
@@ -42,6 +48,29 @@ The server will have two community, `civsix` and `free`.
 ## Client
 Download the latest release on the [release page](https://github.com/MXWXZ/civrip/releases).
 
+### v2.0
+
+1. Execute `civrip.exe`
+2. Click `Install TAP` if status is `UNINST`.
+3. Click `Restart TAP` if status is `STOPPED` or `UNKNOWN`.
+4. Fill in `Server IP` with port, e.g., `1.2.3.4:7654`.
+5. Fill in `Community` configured by server, e.g., `civsix`.
+6. Fill in `Encrypt Key`, this can be arbitrary, e.g., `114514`.
+7. Do not check any network setting and click `Connect`.
+
+If you are game server: 
+1. Make sure server status is `CONNECT`.
+2. Find the LAN IP in the output (e.g., 10.0.0.100).
+3. Disable the firewall, create the game room and tell your IP to the others!
+
+If you are joining others server:
+1. Make sure server status is `CONNECT`.
+2. Fill in `Game IP` with the LAN IP of the game server.
+3. Click `Ping` to make sure you can touch the server.
+4. Start the game. Click `Inject` when you are at the game menu.
+
+### v1.0
+
 1. Execute `civrip.exe`
 2. Click `Install WinIPB` or `Install TAP` if status is `UNINST`.
 3. Click `Restart WinIPB` or `Restart TAP` if status is `STOPPED` or `UNKNOWN`.
@@ -51,7 +80,32 @@ Download the latest release on the [release page](https://github.com/MXWXZ/civri
 7. Do not check any network setting and click `Connect`.
 8. If server status is `CONNECT`, go and play your game! Otherwise, please check the output by yourself.
 
-### Troubleshooting
+## Troubleshooting
+
+### v2.0 FAQ
+
+> I am the game server, but I cannot find the LAN IP.
+
+Please check EDGE connection below.
+
+> I am joining others game, but I cannot ping the server.
+
+Please make sure you have the LAN IP, check EDGE connection below and disable the firewall on the game server.
+
+> I see errors after clicking the `Inject`.
+
+Please start the game first and wait for the main menu. There will be two logs about `Injector` (for DX11 and DX12). It is expected to have one error log and one success log. It is OK when any of them reports success.
+
+> I want to change the Game IP. Do I need to restart the game?
+
+No. Click eject, modify the Game IP and inject again is OK.
+
+> I am using 32-bit system. How to run?
+
+Unfortunately, we do not support 32 bit officially. You can compile the project by yourself (see below).
+
+### EDGE connection
+
 These only work if your server status is `CONNECT`, otherwise please solve the server connection problem first.
 
 If you cannot find the room or cannot connect to the room, please follow the steps below. Please check the game to see if you solve the problem after complete each step:
@@ -68,5 +122,24 @@ If you cannot find the room or cannot connect to the room, please follow the ste
 
 If you can connect, but the connection is not stable, please check `Disable P2P` (and `Force TCP` if possible).
 
+## Compile
+
+It is possible that the injector and the main program are marked as virus by anti-virus softwares. This software and third-party dependencies are 100% open-source. You can compile the program by yourself.
+
+Environment:
+- QT6
+- Visual Studio (C++ Desktop support is the minimum)
+
+Compile:
+1. `cd detours/src` and run `nmake` (Please use VS x64 compile chains).
+2. Open `hook/hook.sln` and compile for `x64 | Release`.
+3. Open `civrip.pro` and compile for `Release`.
+
+Third party:
+- WinIPBroadcast: https://github.com/dechamps/WinIPBroadcast
+- Tap Windows: https://community.openvpn.net/openvpn/wiki/GettingTapWindows
+- n2n: http://github.com/ntop/n2n
+- Injector: https://github.com/nefarius/Injector
+
 ## License
 GNU General Public License v3.0

README_zh_CN.md

@@ -1,10 +1,15 @@
 # civrip
+**100%开源**
+
 简单GUI为文明6及老游戏联机提供虚拟组网。
 
 **本软件完全免费且开源，严禁任何形式的倒卖、二次封装售卖。**
 
 **软件基于GPL3.0协议，二次修改前请遵循协议要求。**
 
+![main](./assets/main_cn.png)
+
+
 ## 为什么有这个项目？
 文明6以及其他老游戏只支持局域网多人游戏（文明6官方服务器国内什么情况懂得都懂），常见的解决方法是创建一个虚拟局域网。
 
@@ -13,7 +18,9 @@
 - [n2n](https://github.com/ntop/n2n): 类似Zerotier，不过需要自建一个协调服务器，当P2P不可用时中转流量。优点是可以指定加密类型和协议，对于国内网络环境比较友好。
 - VPN: 也是一种解决方法，不过对于臭打游戏的而言算是杀鸡用牛刀了，效果也不一定好。
 
-文明6更是重量级，由于只搜索默认网卡的网段，但大部分上述方案都使用了虚拟网卡，因此还需要 [WinIPBroadcast](https://github.com/dechamps/WinIPBroadcast) 将数据包转发到所有网卡才能搜到房间。
+~~文明6更是重量级，由于只搜索默认网卡的网段，但大部分上述方案都使用了虚拟网卡，因此还需要 [WinIPBroadcast](https://github.com/dechamps/WinIPBroadcast) 将数据包转发到所有网卡才能搜到房间。~~
+
+更新：感谢 @xaxys (https://github.com/xaxys/injciv6/tree/master) 提供的思路，现在可以采用hook函数的方式解决。
 
 由于配置上述方案对于玩家而言太过复杂，群友的网络环境千奇百怪，因此我写了这个基于n2n的小工具来自动化大部分流程，基本上是基于文明6联机而优化的，其他老游戏应该也能使用。
 
@@ -42,6 +49,30 @@ free
 ## 客户端
 在[release page](https://github.com/MXWXZ/civrip/releases)下载最新客户端。
 
+
+### v2.0
+
+1. 双击打开 `civrip.exe`
+2. 如果客户端状态是 `未安装`，请点击 `安装 TAP`。
+3. 如果客户端状态是 `已停止` 或 `未知`，请点击 `重启 TAP`。
+4. 填写 `服务器 IP`，包括端口号。例如 `1.2.3.4:7654`。
+5. 填写 `频道`，需要是服务器所定义的。例如 `civsix`。
+6. 填写 `加密密钥`，可任意填写。例如 `114514`。
+7. 不要选中任何重量级网络设置，点击 `连接`。
+
+如果你是房主：
+1. 确保服务器状态是 `已连接`。
+2. 在日志里找到内网IP（例如 10.0.0.100）。
+3. 关闭防火墙，创建游戏房间并将IP告知其他人！
+
+如果你要加入其他人的游戏：
+1. 确保服务器状态是 `已连接`。
+2. 在 `游戏IP` 中填写房主的内网IP。
+3. 点击 `Ping` 检测连接情况。
+4. 启动游戏，在主菜单界面点击 `注入`。
+
+### v1.0
+
 1. 双击打开 `civrip.exe`
 2. 如果客户端状态是 `未安装`，请点击 `安装 WinIPB` 或者 `安装 TAP`。
 3. 如果客户端状态是 `已停止` 或 `未知`，请点击 `重启 WinIPB` 或者 `重启 TAP`。
@@ -51,7 +82,31 @@ free
 7. 不要选中任何重量级网络设置，点击 `连接`。
 8. 如果服务器状态是 `已连接`，打开游戏开玩！否则你需要根据日志输出自行解决连接问题。
 
-### 疑难杂症
+## 疑难杂症
+
+### v2.0 FAQ
+
+> 我是房主，但在日志里找不到内网IP。
+
+请参见下方协调服务器连接问题。
+
+> 我要加入其他人的游戏，但我Ping不通房主。
+
+请先确保自己获取了内网IP，并参考下方解决协调服务器连接问题，最后让房主确保关闭防火墙。
+
+> 我点击 `注入` 后有报错。
+
+请先启动游戏，等待主菜单出现后注入。日志中会有两个 `Injector` 相关日志（分别对应DX11和DX12）。其中一个日志报错一个日志成功是正常现象，确保任意一个日志成功即可。
+
+> 我要修改游戏IP，需要重启游戏么？
+
+不需要，点击弹出，修改IP，重新注入即可。
+
+> 我是32位系统，如何运行？
+
+很不幸，目前我们并不对32位系统提供技术支持。你可以自行编译程序，理论上没有问题（见下方）。
+
+### 协调服务器连接问题
 请注意，下面的方法仅限于服务器状态是 `已连接`，但是搜不到房间或进不去房间，如果你连服务器都无法连接则需要根据日志自行解决（通常是服务器配置问题，例如防火墙阻断）。
 
 如果搜不到房或者无法连接进房，请尝试下面的步骤。注意请每做一步试一下问题是否解决，能否进入游戏：
@@ -68,5 +123,24 @@ free
 
 如果可以连接，但是连接不稳定或很卡，请勾选 `禁用 P2P`（还是卡请同时勾选 `强制 TCP`）。
 
+## 编译
+
+由于程序存在线程注入高危操作，可能会被杀毒软件报毒。本程序及所有第三方软件均为100%开源，你可以自行编译程序。
+
+环境：
+- QT6
+- Visual Studio (至少需要C++ Desktop组件)
+
+编译
+1. `cd detours/src`，运行 `nmake` （请使用 VS x64 编译工具链）。
+2. 打开 `hook/hook.sln` 并编译 `x64 | Release`。
+3. 打开 `civrip.pro` 并编译 `Release`。
+
+第三方软件：
+- WinIPBroadcast: https://github.com/dechamps/WinIPBroadcast
+- Tap Windows: https://community.openvpn.net/openvpn/wiki/GettingTapWindows
+- n2n: http://github.com/ntop/n2n
+- Injector: https://github.com/nefarius/Injector
+
 ## License
 GNU General Public License v3.0

assets/main_cn.png

@@ -460,3 +460,90 @@ void CivRIP::closeEvent(QCloseEvent *event) {
     event->accept();
   }
 }
+
+void CivRIP::on_pushButton_7_clicked() {
+  QProcess process;
+  process.startCommand("ping -w 2000 -n 2 " + ui->key_2->text());
+  process.waitForFinished(-1);
+  ui->output->append(process.readAll());
+}
+
+void CivRIP::on_inject_clicked() {
+  auto srvMgr = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
+  if (!srvMgr) {
+    ui->output->append(QString("OpenSCManager failed: %1").arg(GetLastError()));
+    ChangeWinIPB(STATUS_WINIPB_UNKNOWN);
+    return;
+  }
+
+  auto srvDDK = OpenService(srvMgr, _T("WinIPBroadcast"), SERVICE_ALL_ACCESS);
+  if (srvDDK) {
+    SERVICE_STATUS_PROCESS ssStatus;
+    if (!QueryService(srvMgr, srvDDK, &ssStatus)) {
+      ChangeWinIPB(STATUS_WINIPB_UNKNOWN);
+      return;
+    }
+
+    ControlService(srvDDK, SERVICE_CONTROL_STOP,
+                   (LPSERVICE_STATUS)&ssStatus); // ignore stop error
+    while (ssStatus.dwCurrentState != SERVICE_STOPPED) {
+      auto dwWaitTime = ssStatus.dwWaitHint / 10;
+      if (dwWaitTime < 1000)
+        dwWaitTime = 1000;
+      else if (dwWaitTime > 10000)
+        dwWaitTime = 10000;
+      Sleep(dwWaitTime);
+
+      if (!QueryService(srvMgr, srvDDK, &ssStatus)) {
+        ChangeWinIPB(STATUS_WINIPB_UNKNOWN);
+        return;
+      }
+      if (ssStatus.dwCurrentState == SERVICE_STOPPED)
+        break;
+    }
+    ui->output->append(QString("WinIPBroadcast Stopped"));
+    ChangeWinIPB(STATUS_WINIPB_STOPPED);
+    repaint();
+  } else {
+    ChangeWinIPB(STATUS_WINIPB_UNINSTALLED);
+  }
+
+  if (srvMgr)
+    CloseServiceHandle(srvMgr);
+  if (srvDDK)
+    CloseServiceHandle(srvDDK);
+
+  QFile file("address.txt");
+  file.open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate);
+  QTextStream out(&file);
+  out << ui->key_2->text();
+  file.close();
+
+  if (ui->inject->text() == tr("Inject")) {
+    QProcess process;
+    process.startCommand("Injector.exe -n CivilizationVI.exe -i hook.dll");
+    process.waitForFinished(-1);
+    ui->output->append(process.readAllStandardOutput());
+    ui->output->append(process.readAllStandardError());
+
+    process.startCommand("Injector.exe -n CivilizationVI_DX12.exe -i hook.dll");
+    process.waitForFinished(-1);
+    ui->output->append(process.readAllStandardOutput());
+    ui->output->append(process.readAllStandardError());
+
+    ui->inject->setText(tr("Eject"));
+  } else {
+    QProcess process;
+    process.startCommand("Injector.exe -n CivilizationVI.exe -e hook.dll");
+    process.waitForFinished(-1);
+    ui->output->append(process.readAllStandardOutput());
+    ui->output->append(process.readAllStandardError());
+
+    process.startCommand("Injector.exe -n CivilizationVI_DX12.exe -e hook.dll");
+    process.waitForFinished(-1);
+    ui->output->append(process.readAllStandardOutput());
+    ui->output->append(process.readAllStandardError());
+
+    ui->inject->setText(tr("Inject"));
+  }
+}

assets/main_en.png

@@ -1,7 +1,7 @@
 #ifndef CIVRIP_H
 #define CIVRIP_H
 
-#define VERSION "1.0.0"
+#define VERSION "2.0.0"
 
 #include <QMainWindow>
 #include <QProcess>
@@ -69,7 +69,11 @@ private slots:
 
   void closeEvent(QCloseEvent *event) override;
 
-private:
+  void on_pushButton_7_clicked();
+
+  void on_inject_clicked();
+
+  private:
   QProcess edge;
   QTranslator *translator;
   Ui::CivRIP *ui;