HsMod

Hearthstone Modify Based on BepInEx 基于BepInEx的炉石修改，插件源代码位于github.com/Pik-4/HsMod，插件不会收集您的任何信息；项目遵循AGPL-3.0，仅用作学习研究。

已实现的功能

1. 支持齿轮快慢8倍速（设置中允许扩展到快慢32倍）
2. 允许使用VerifyWebCredentials登录（亦支持命令行启动，不需要启动战网）。
3. 屏蔽错误报告，当发生异常时，不会向暴雪报告错误信息。
4. 禁用掉线，允许长时间无操作
5. 允许报错自动退出
6. 允许移除窗口焦点
7. 解除窗口大小化限制
8. 拦截弹窗（如无法匹配等）提示。
9. 移除中国特色提示
10. 支持移除削弱补丁提示，移除广告推销，移除天梯结算奖励等弹窗
11. 允许屏蔽对局结束的升级提示、结算提示
12. 允许屏蔽战令、成就等奖励领取提示
13. 允许快速开包，空格一次开5张
14. 允许在开包时自动分解全额分解的卡牌
15. 允许显示游戏帧率信息
16. 允许修改游戏帧率
17. 支持在收藏、英雄、卡背、打击特效、酒馆面板等场景，右键选中卡牌时显示Dbid
18. 支持收藏显示9+卡牌实际数量
19. 允许在0-0（可以不组卡牌）时放弃对决
20. 允许自动领取竞技场、对决等奖励（结束时点包裹）
21. 允许进入炉石开发者模式
22. 好友观战自动旋转卡牌、自动观战双方
23. 支持炉边聚会模拟定位
24. 允许自动屏蔽对手表情或设置对方表情上限；支持屏蔽思考表情；支持屏蔽鲍勃语音；支持对战跳过英雄介绍
25. 支持表情无冷却（表情发送最小间隔1.5秒）
26. 支持表情快捷键
27. 支持快速战斗（跳过部分动画，比齿轮更丝滑，开启时屏蔽终结特效，该选项可在酒馆与佣兵(PVE)生效，佣兵可能在最终死亡结算有卡顿，）
28. 支持炉石自动金卡、钻石卡
29. 允许单独屏蔽对手卡牌特效
30. 允许显示对手完整战网昵称
31. 允许点击头像获取酒馆玩家昵称
32. 允许对战中添加对手
33. 允许在传说前显对手示天梯等级
34. 支持标记对手已知卡牌
35. 允许使用快捷键静音炉石
36. 允许自动举报对手；当自动举报对手启用时，可以自动生成对局记录
37. 支持模拟拔线（需要开启快捷键）
38. 支持一键自动分解全额分解的卡牌（需要开启快捷键）
39. 支持一键移除新！（需要开启快捷键，可能需要重新进入收藏，佣兵可能重启后失效）
40. 支持修改对战英雄皮肤、酒馆英雄皮肤、终结特效、对战面板、酒馆面板、幸运币等皮肤信息。（需要配置HsSkins.cfg，或在设置中修改，对局中更新需要在按下F4保存后，模拟拔线）
41. 支持修改卡背（对局中自动生效）
42. 支持佣兵随机皮肤，强制钻石皮肤等
43. 支持屏蔽佣兵宝箱、天梯奖励等弹窗
44. 支持屏蔽佣兵对战界面缩放
45. 支持模拟开包（支持结果随机，支持自定义卡包类型、数量、稀有度、品质等信息；支持模拟固定结果）
46. 支持设备模拟（允许领取iOS、Android等设备的卡包卡背，可能需要一局对战）
47. 支持金币购买纳克萨玛斯、黑石山、探险者协会等冒险（也支持卡拉赞，但无法打序章）
48. 允许强开卡拉赞（不能打序章，未通关前不能跳关）
49. 支持信息展示（showinfo，需要启用插件，默认HTTP，端口58744）；支持显示佣兵养成进度、开包历史信息等。
50. 支持接收炉石启动参数，如指定分辨率大小等。
51. 支持Webshell，路径为/shell。需要在设置中开启，目前中文显示可能存在乱码。
52. 允许通过Web读取本地文件，即解析静态页面。该功能尚在开发中，目前以Hearthstone\website作为根目录。
53. 允许解除套牌识别限制，以开启万宁炉石。

安装说明

Windows

1. 编译HsMod或从Releases下载HsMod.dll。

2. 配置BepInEx。

   2.1. 下载BepInEx_x86，并将其解压到炉石根目录Hearthstone\下。

   2.2. 创建一个目录Hearthstone\BepInEx\unstripped_corlib\；下载Mono和Unity，并将其解压在该目录；将项目目录HsMod/LibUnityMono下所有dll复制到unstripped_corlib目录下。

   2.3. 修改Hearthstone\doorstop_config.ini，将dllSearchPathOverride= 替换成dllSearchPathOverride=BepInEx\unstripped_corlib

3. 将HsMod.dll存放在Hearthstone\BepInEx\plugins。

4. 安装BepInEx配置管理BepInExConfigManager.Mono，解压到Hearthstone\BepInEx\即可；进入游戏后F5进行相关控制。

Mac

1. Download the latest version of BepInEx_unix and extract it to Hearthstone/

2. Download original Mono and Unity libraries and unpack to Hearthstone/BepInEx/unstripped_corlib. Copy all dll which under the project folder HsMod/LibUnityMonoUnix (cp HsMod/LibUnityMonoUnix/* Hearthstone/BepInEx/unstripped_corlib/ ). ( PS. Mono and Unity version must same as Hearthstone ).

3. Edit the run_bepinex.sh file replacing the line export DOORSTOP_CORLIB_OVERRIDE_PATH=""with DOORSTOP_CORLIB_OVERRIDE_PATH="$BASEDIR/BepInEx/unstripped_corlib"

4. Edit the file run_bepinex.sh replacing the line executable_name="" with executable_name="Hearthstone.app"

5. Run command in console chmod u+x run_bepinex.sh

6. Get the token here and copy after http://localhost:0/?ST= and before &accountId=

   # Some verify url
   https://www.battlenet.com.cn/login/zh-cn/?app=wtcg
   https://us.battle.net/login/en/?app=wtcg
   https://tw.battle.net/login/zh/?app=wtcg
   https://kr.battle.net/login/zh/?app=wtcg
   https://eu.battle.net/login/zh/?app=wtcg
   ...
   

7. Create a client.config file with the following content, instead of token - insert the token obtained in the previous step. Env value xx.actual.battle.net; xx same as the token first two characters. E.g

   [Config]
   Version = 3
   [Aurora]
   VerifyWebCredentials = "token"
   ClientCheck = 0
   Env.Override = 1
   Env = cn.actual.battle.net
   

8. Download the HsMod Releases and unzip to Hearthstone/BepInEx/plugins

9. Download the BepInExConfigManager.Mono and unzip to Hearthstone/BepInExAfter entering the game, press F5 to control HsMod.

Now the game needs to be launched only through ./run_bepinex.sh

If the token becomes obsolete and the game stops opening, then you just need to update it in the client.config.

Mac上首次运行可能会提示战网登录错误，请找到HsMod.cfg，修改激活插件即可，详细可参考 #8。

Linux

1. 编译HsMod或从Releases下载HsMod.dll。

2. 参考0xf4b1/hearthstone-linux安装Linux版Hearthstone。（理论上此时会配置好client.config）

3. 下载 BepInEx_unix（注：目前采用BepInEx5）并将其解压到炉石根目录hearthstone/下。

4. 创建一个目录hearthstone/BepInEx/unstripped_corlib/；

   1. 下载Mono和Unity，解压提取dll，将所有dll复制到该目录下目录下。

   2. 将项目目录HsMod/LibUnityMonoUnix下所有UniTask开头的.dll复制到该目录下

      cp HsMod/LibUnityMonoUnix/UniTask* hearthstone/BepInEx/unstripped_corlib/

   注：也可直接将项目目录HsMod/LibUnityMonoUnix下所有.dll复制到该目录下

5. 修改unix_bepinex.sh

   1. 替换 export DOORSTOP_CORLIB_OVERRIDE_PATH=""为 DOORSTOP_CORLIB_OVERRIDE_PATH="$BASEDIR/BepInEx/unstripped_corlib"
   2. 替换executable_name="" 为 executable_name="Bin/Hearthstone.x86_64"
   3. 替换完成后，执行sed -i "s/\r/ /g" ./run_bepinex.sh修改文件结尾换行符，以匹配Linux文件系统。

6. 如果配置正确，此时目录结构应该如下。

   hsmod@hsmod:~/hearthstone-linux/hearthstone$ ls -alh
   drwxrwxr-x 9 a a 4.0K Jan 12 12:07 .
   drwxrwxr-x 9 a a 4.0K Jan 12 09:27 ..
   drwxrwxr-x 4 a a 4.0K Jan 12 11:52 BepInEx
   drwxrwxr-x 3 a a 4.0K Jan 12 12:07 Bin
   -rw-rw-r-- 1 a a 1.4K Aug 30 02:53 changelog.txt
   -rw-rw-r-- 1 a a  103 Jan 12 11:16 client.config
   drwxrwxr-x 3 a a 4.0K Jan 12 10:46 Data
   drwxrwxr-x 2 a a 4.0K Jan 12 11:46 doorstop_libs
   -rw-rw-r-- 1 a a    5 Jan 12 09:27 .locale
   -rwxrwxr-x 1 a a 295K Jan 12 11:16 login
   drwxrwxr-x 7 a a 4.0K Jan 12 12:07 Logs
   drwxrwxr-x 5 a a 4.0K Jan 12 09:27 .ngdp
   -rw-rw-r-- 1 a a    3 Jan 12 09:27 .region
   -rwxrwxr-x 1 a a 4.8K Jan 12 12:07 run_bepinex.sh
   drwxrwxr-x 3 a a 4.0K Jan 12 10:47 Strings
   -rw-rw-r-- 1 a a   48 Jan 12 11:23 token
   -rw-rw-r-- 1 a a   12 Jan 12 11:16 .unity
   -rw-rw-r-- 1 a a   21 Jan 12 10:47 .version
   

7. 如果未配置client.config，参考MacOS安装说明中6-7步，配置client.config

8. 将HsMod.dll存放在hearthstone/BepInEx/plugins目录下（如果plugins目录不存在，需要手动创建）。

9. 安装BepInEx配置管理BepInExConfigManager.Mono，解压到hearthstone/BepInEx/即可；进入游戏后F5进行相关控制。

10. 为run_bepinex.sh赋予执行权限

    chmod u+x run_bepinex.sh

11. 执行./run_bepinex.sh，享受炉石吧。

版本说明

如HsMod版本3.0.0.0：

第一位 3 => 炉石大版本。例如： 3 => 26

第二位 0 => 炉石在该版本更新次数，不与炉石小版本对应；此外，当炉石发生更新，但Assembly-CSharp.dll等文件没有变化时，该数字不会更新。例如：0 => 26.x.y.z

第三位 0 => 当HsMod在该炉石版本有新功能时，此数字+1；当第二位发生变化时，此数字置零。

第四位 0 => 编译版本。主要记录修复bug次数，与第三位对应。

炉石版本更新不一定会导致HsMod失效，如果HsMod插件功能正常，可以不随Release更新。HsMod更新特性可参考commit记录。

补充说明

1. 插件不可放置在含有中文的目录下，即炉石安装路径不能含有中文。
2. 本插件可能与基于Assembly-CSharp.dll的修改冲突，修改Assembly-CSharp.dll可能导致IL指令定位异常，进而造成相关Patch无法生效；还可能与其他BepInEx插件（例如佣兵、MixMod）冲突，原因是同一个方法可能在两个插件中都存在Patch，当有多个Patch时，运行结果可能会异常，本插件没有检测原方法是否被修改。
3. 皮肤的配置文件在Hearthstone\BepInEx\config\HsSkins.cfg。若无，则在运行游戏后自动创建。
4. F4为固定快捷键，用于获取游戏内部分信息（相关信息存放在Hearthstone\BepInEx\目录下）、更新皮肤配置、重启Web服务等。其余快捷键均可自定义配置。
5. 本插件在默认状态下，几乎全部的功能均需要手动开启；插件大部分功能能在配置中找到说明，少部分功能只在Patch中提及（如最小化限制）。
6. 本插件Web Server（即Showinfo）的默认端口为58744，一般情况下，监听本地所有IP，使用云服务器时，请注意防火墙、安全组等配置。
7. 对局统计所使用的log文件是BepInEx\HsMatch.log，可在设置中修改。（字段以,分隔）
8. 出现问题时先尝试删除相关.cfg配置文件（一般位于BepInEx\config\），进行重新配置；如果依然存在问题，请带上HsMod.cfg提交Issues，但不保证及时解答。
9. GetHsLib.py用于更新炉石自有运行库，install.bat用于将编译好的HsMod.dll复制到默认炉石目录（前提是BepInEx已经配置好）。此外，在push修改版本号后（PluginInfo.cs发生变化后），会自动生成release。
10. 如果出现皮肤显示异常，请检查HsSkins.cfg，并尝试删除HsMod.cfg重新进行配置。
11. 如果修改设置无法保存，请检查是否启用其他炉石插件。
12. BepInEx请选择BepInEx 5，由于BepInEx 6目前还在pre-release，暂时不做适配。

client.config

client.config用于绕过战网启动炉石，该文件位于Hearthstone.exe所在文件夹，内容如下

[Config]
Version = 3
[Aurora]
VerifyWebCredentials = "VerifyWebCredentials"
ClientCheck = 0
Env.Override = 1
Env = cn.actual.battle.net

一些token获取链接

https://www.battlenet.com.cn/login/zh-cn/?app=wtcg
https://tw.battle.net/login/zh/?app=wtcg
https://kr.battle.net/login/zh/?app=wtcg
https://us.battle.net/login/en/?app=wtcg
https://eu.battle.net/login/en/?app=wtcg

在启用插件后，支持./Hearthstone.exe VerifyWebCredentials 命令启动炉石（但需要有client.config文件，现在不需要了！）。

TODO

1. 整理ReadMe，更新Wiki等；整理配置与Patch之间关系；多语言支持
2. 游戏内一键更换英雄皮肤，目前只能通过模拟掉线更新
3. 重构Showinfo相关Web页面。
4. 适配Mac
5. 修复佣兵相关功能

参考

1. MixMod_4pda
2. MixMod_github
3. Hearthstone Advanced Mod
4. 从0开始教你使用BepInEx为unity游戏制作插件Mod
5. BepInEx Docs
6. Harmony
7. List of CIL instructions
8. hearthstone-linux