2026-04-30 添加音频

Author: GlitchedReme

RitsuLib/10 - 添加音频/README.md

@@ -0,0 +1,113 @@
+## 方法一：使用Fmod加载
+
+使用塔2使用的fmod工具进行加载。
+
+### 下载fmod
+
+前往官网 https://www.fmod.com/download#fmodstudio ，下载2.03.06版本的fmod studio。
+
+![alt text](../../images/image35.png)
+
+安装完毕后打开。
+
+### 下载原版工程
+
+先下载一个拥有原版音频guid对应的工程，可以下载ritsulib作者制作的音频示例工程（整个一起下载）： https://github.com/BAKAOLC/SwarmTheSpire-FModProject ，或者网盘： https://pan.baidu.com/s/1yuxPkDpCV8EVLkDubqiirg?pwd=apar 。
+
+下载完毕后打开。
+
+### 导入音频
+
+点击左侧的`Assets`栏，将你的音频拖入其中或者右键`Import Assets`。
+
+![alt text](../../images/image36.png)
+
+### 重命名bank
+
+点击中间的`Banks`栏，将两个bank重命名为你的项目的名字，最好也是`XXX`和`XXXMaster`。
+
+* 不能删除然后重建，不能叫`Master`。
+
+![alt text](../../images/image37.png)
+
+### 新建event
+
+点击左侧的`Events`栏，可以右键新建文件夹，套一些文件夹改名防止你和别人的id撞上。然后右键新建event。
+
+![alt text](../../images/image38.png)
+
+右键你的event，点击`Assgin To Bank`，选择`Test`或者你重命名的那个。（*不是Master那个*）
+
+![alt text](../../images/image39.png)
+
+### 新建sheet
+
+然后点击你刚才的event，中间会出现sheet界面。在其中右键新建一个任意类型的sheet。
+
+* 简单来说，timeline可以实现音频拼接或者延迟触发，action可以多个音频随机触发一个，parameter可以调整音频的参数等。
+
+![alt text](../../images/image42.png)
+
+例如我们新建一个timeline sheet，然后点击assets将音频素材拖到轨道里。
+
+![alt text](../../images/image40.png)
+
+### 构建
+
+* 点击菜单栏的`File`，点击`Build`，然后再点击`Export GUIDs`。
+
+* 从你保存的项目的根目录找到`Build`这个文件夹，复制`GUIDs.txt`和`Desktop/Test.bank`（或者你的命名的bank，不是任何其他带有Master的bank）到你的mod项目中，例如复制到`Test/audios`里。
+
+* 你也可以设置自动构建的路径，点击`Edit - Preference - Build`选择构建路径。
+
+![alt text](../../images/image43.png)
+
+### 代码加载
+
+在你的初始化函数中加载：
+
+```csharp
+using STS2RitsuLib.Audio;
+
+namespace Test.Scripts;
+
+[ModInitializer(nameof(Init))]
+public class Entry
+{
+    public static void Init()
+    {
+        // 其余省略
+        FmodStudioServer.TryLoadBank("res://Test/audios/Test.bank");
+        FmodStudioServer.TryWaitForAllLoads();
+        FmodStudioServer.TryLoadStudioGuidMappings("res://Test/audios/GUIDs.txt");
+    }
+}
+```
+
+然后你指定的fmod就被加载到游戏里了。例如使用：
+
+* 人物音频：
+
+```csharp
+Audio: new(
+    // AttackSfx: null,
+    // CastSfx: null,
+    // DeathSfx: null,
+    CharacterSelectSfx: "event:/sfx/kokodayo"
+    // CharacterTransitionSfx: "event:/sfx/ui/wipe_ironclad"
+),
+```
+
+* 卡牌音效：
+
+```csharp
+await DamageCmd.Attack(DynamicVars.Damage.BaseValue)
+    .FromCard(this)
+    .WithHitFx(sfx: "event:/sfx/sword_slash") // 伤害音效
+    .Targeting(cardPlay.Target!)
+    .Execute(choiceContext);
+```
+和
+```csharp
+    SfxCmd.Play("event:/sfx/block_gain");
+```

RitsuLib/14 - 添加新人物/README.md

@@ -297,8 +297,6 @@ TestEnergyCounter (Control)
 
 ![alt text](../../images/image19.png)
 
-*仅供参考，我这没挂脚本，需要挂脚本*
-
 ## 自定义商店模型
 
 修改`AssetProfile`里的：
@@ -647,25 +645,20 @@ position = Vector2(0, -144)
 ### test_energy_counter.tscn
 
 ```tscn
-[gd_scene load_steps=5 format=3 uid="uid://cs3a5onikvhi4"]
+[gd_scene load_steps=2 format=3 uid="uid://cs3a5onikvhi4"]
 
 [ext_resource type="Texture2D" uid="uid://hn2nofekpwrp" path="res://icon.svg" id="1_85qf2"]
-[ext_resource type="Script" uid="uid://b4eaf7kin174o" path="res://Scripts/NTestEnergyCounter.cs" id="1_moaty"]
-[ext_resource type="Script" uid="uid://b8vmh6070x38m" path="res://Scripts/NTestParticlesContainer.cs" id="2_sphyw"]
-[ext_resource type="Script" uid="uid://camgj4bhk5dps" path="res://Scripts/TestMegaLabel.cs" id="4_ea8ix"]
 
 [node name="TestEnergyCounter" type="Control"]
 layout_mode = 3
 anchors_preset = 0
 offset_right = 128.0
 offset_bottom = 128.0
-script = ExtResource("1_moaty")
 metadata/_edit_lock_ = true
 
 [node name="EnergyVfxBack" type="Node2D" parent="."]
 unique_name_in_owner = true
 position = Vector2(64, 64)
-script = ExtResource("2_sphyw")
 
 [node name="Layers" type="Control" parent="."]
 unique_name_in_owner = true
@@ -695,7 +688,6 @@ expand_mode = 1
 [node name="EnergyVfxFront" type="Node2D" parent="."]
 unique_name_in_owner = true
 position = Vector2(64, 64)
-script = ExtResource("2_sphyw")
 
 [node name="Label" type="Label" parent="."]
 layout_mode = 1
@@ -719,7 +711,6 @@ theme_override_font_sizes/font_size = 36
 text = "3/3"
 horizontal_alignment = 1
 vertical_alignment = 1
-script = ExtResource("4_ea8ix")
 ```
 
 ### test_character_merchant.tscn

RitsuLib/README.md

@@ -2,14 +2,16 @@
 
 https://github.com/BAKAOLC/STS2-RitsuLib
 
-> 以下内容使用ritsulib0.2.3。
+> 以下内容使用ritsulib0.2.15。
 
 先依赖ritsulib才能查看这里里面的文章。
 
 ## 下载
 
 * 前往 https://github.com/BAKAOLC/STS2-RitsuLib/releases 下载`dll`，和`json`两个文件，把他们放在`mods`文件夹里。记住你下载的版本。
 
+* 请根据你的游戏版本选择对应的`RitsuLib`版本。例如不带后缀的`STS2.RitsuLib.XXX.github.zip`一般跟随测试版，而例如`STS2.RitsuLib.Compat.0.103.2.XXX.github.zip`这种是兼容`0.103.2`正式版的版本。
+
 * 在`csproj`文件中相应位置引用`STS2-RitsuLib.dll`，如下，两种方式都可。推荐使用nuget。
 
 ```xml
@@ -31,6 +33,8 @@ https://github.com/BAKAOLC/STS2-RitsuLib
     </Reference> -->
     <!-- NuGet获取，注意版本是否一致，不一致手动更改Version -->
     <PackageReference Include="STS2.RitsuLib" Version="*" />
+    <!-- 如果你在正式版开发用这个 -->
+    <!-- <PackageReference Include=" STS2.RitsuLib.Compat.0.103.2 " Version="*" /> -->
   </ItemGroup>
 ```
 

Visuals/01 - 卡图&皮肤替换/README.md Visuals/01 - 卡图&Spine/README.mdVisuals/01 - 卡图&皮肤替换/README.md renamed to Visuals/01 - 卡图&Spine/README.md

@@ -24,15 +24,15 @@
     }
 ```
 
-## Spine导入&模型替换
+## Spine导入
 
 尖塔使用`4.2.43`版本的Spine，在这之下版本的不能直接使用。（神秘链接或网盘：https://github.com/wang606/SpineSkeletonDataConverter ）
 
-* 第一步，安装一个`Spine Godot Extension`，建议直接下载我编译好的：https://pan.baidu.com/s/1yuxPkDpCV8EVLkDubqiirg?pwd=apar 。参考 https://zh.esotericsoftware.com/spine-godot 。
+* 第一步，安装一个`Spine Godot Extension`，建议直接下载我编译好的：https://pan.baidu.com/s/1yuxPkDpCV8EVLkDubqiirg?pwd=apar 。参考 https://zh.esotericsoftware.com/spine-godot 。把里面的文件放到你的项目根目录，然后~~可能需要~~重启一下Godot。
 
-* 把里面的文件放到你的项目根目录，然后~~可能需要~~重启一下Godot。把spine中导出的atlas,skel,png文件放入项目指定位置，能在Godot文件系统中看到就算成功。
+* 把spine中导出的atlas,skel,png文件放入项目你自己指定的位置，能在Godot文件系统中看到就算成功。
 
-* 创建一个`SpineSkeletonDataResource`，并把`Atlas Res`和`SkeletonFile Res`分别设置为atlas和skel文件。
+* 右键godot文件系统创建资源，创建一个`SpineSkeletonDataResource`，并把`Atlas Res`和`SkeletonFile Res`分别设置为atlas和skel文件。
 
 * 你的战斗人物模型需要有`idle_loop`（待机循环），`attack`（攻击动作），`cast`（能力卡动作），`hurt`（受伤），`die`（死亡）这些动画名。
 
@@ -44,59 +44,7 @@
 
 ![3](../../images/image16.png)
 
-然后可以参考这段替换角色：（此处仅替换战斗人物且不播放初始动画，仅供参考）
-
-```csharp
-using System;
-using Godot;
-using HarmonyLib;
-using MegaCrit.Sts2.Core.Bindings.MegaSpine;
-using MegaCrit.Sts2.Core.Modding;
-using MegaCrit.Sts2.Core.Nodes.Combat;
-
-namespace Test.Scripts;
-
-[ModInitializer(nameof(Init))]
-public static class Entry
-{
-    // 替换哪个角色
-    private const string TargetCharacterId = "IRONCLAD";
-
-    // spine资源的路径
-    private const string SkinPath = "res://spineskins/test_skin.tres";
-    // Harmony的ID，确保唯一性
-    private const string HarmonyId = "sts2.reme.spineskintemplate";
-
-    private static Resource? _skinData;
-
-    public static void Init()
-    {
-        _skinData = ResourceLoader.Load<Resource>(SkinPath, null, ResourceLoader.CacheMode.Reuse);
-
-        new Harmony(HarmonyId).PatchAll();
-    }
-
-    [HarmonyPatch(typeof(NCreature), nameof(NCreature._Ready))]
-    private static class NCreature_Ready_Patch
-    {
-        private static void Postfix(NCreature __instance)
-        {
-            if (_skinData == null) return;
-
-            var player = __instance?.Entity?.Player;
-            if (player == null) return;
-
-            if (!string.Equals(player.Character.Id.Entry, TargetCharacterId, StringComparison.OrdinalIgnoreCase))
-                return;
-
-            var visuals = __instance.Visuals;
-            if (visuals?.SpineBody == null || !visuals.HasSpineAnimation) return;
-
-            visuals.SpineBody.SetSkeletonDataRes(new MegaSkeletonDataResource(_skinData));
-        }
-    }
-}
-```
+~~然后可以参考这段替换角色：（此处仅替换战斗人物且不播放初始动画，仅供参考）~~ 以前的代码功能太少，为了不误导新人这里删了
 
 ## 任意模型替换思路