? armor = ModLoader.GetTable("gml_GlobalScript_table_armor");
40 |
41 | File.WriteAllLines(
42 | Path.Join(dir.FullName, Path.DirectorySeparatorChar.ToString(), "_all_items.csv"),
43 | data.GameObjects.Select(t => t.Name.Content).Where(x => x.Contains("o_inv_")).Select(x => x.Replace("o_inv_", ""))
44 | );
45 |
46 | if (weapons != null)
47 | {
48 | File.WriteAllLines(
49 | Path.Join(dir.FullName, Path.DirectorySeparatorChar.ToString(), "_all_weapons.csv"),
50 | weapons.Select(x => string.Join(';', x.Split(';').Take(4)))
51 | );
52 | }
53 |
54 | if (armor != null)
55 | {
56 | File.WriteAllLines(
57 | Path.Join(dir.FullName, Path.DirectorySeparatorChar.ToString(), "_all_armors.csv"),
58 | armor.Select(x => string.Join(';', x.Split(';').Take(6)))
59 | );
60 | }
61 | }
62 | ///
63 | /// Export all preset data for all dungeons in json.
64 | ///
65 | private static void ExportPresets(UndertaleData data)
66 | {
67 | GlobalDecompileContext context = new(ModLoader.Data, false);
68 | File.WriteAllText("json_preset_bastion.json", Decompiler.Decompile(data.Code.First(t => t.Name.Content.Contains("scr_preset_bastion_1")), context));
69 | File.WriteAllText("json_preset_catacombs.json", Decompiler.Decompile(data.Code.First(t => t.Name.Content.Contains("scr_preset_catacombs")), context));
70 | File.WriteAllText("json_preset_crypt.json", Decompiler.Decompile(data.Code.First(t => t.Name.Content.Contains("scr_preset_crypt_1")), context));
71 | }
72 | ///
73 | /// Export data for code exploration in json or csv.
74 | ///
75 | public static void Export(this UndertaleData data, DataType dataType)
76 | {
77 | try
78 | {
79 | switch (dataType)
80 | {
81 | case DataType.Codes:
82 | ExportCodes(data);
83 | break;
84 | case DataType.Items:
85 | ExportItems(data);
86 | break;
87 | case DataType.DungeonPresets:
88 | ExportPresets(data);
89 | break;
90 | }
91 | }
92 | catch (Exception ex)
93 | {
94 | Log.Error(ex, "Something went wrong while exporting {{{0}}}", dataType);
95 | }
96 | }
97 | }
98 | }
--------------------------------------------------------------------------------
/Controls/MyToggleButton.xaml:
--------------------------------------------------------------------------------
1 |
9 |
10 |
11 |
12 |
13 |
14 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
32 |
33 |
34 |
35 |
36 |
41 |
42 |
48 |
49 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
--------------------------------------------------------------------------------
/docs/guides/how-to-play-mod.en.md:
--------------------------------------------------------------------------------
1 | # Installing Mods
2 |
3 | ## Downloading ModShardLauncher
4 |
5 | In order to install mods, you will require the **ModShardLauncher**.
6 | You can grab it on **Github** by clicking the button below.
7 |
8 |
9 | [ModShardLauncher :octicons-link-external-16:](https://github.com/DDDDDragon/ModShardLauncher/releases){ .md-button .md-button--primary}
10 |
11 | Make sure you download the `msl.zip` file, and ^^**not the source code**^^.
12 |
13 | Alternatively, you can build ModShardLauncher from source, but it's out of this guide's scope.
14 |
15 |
16 | If launching MSL opens a console and closes immediately, you may require the **.NET Desktop Runtime 6.0**
17 |
18 | [.NET Desktop Runtime 6.0 :octicons-link-external-16:](https://dotnet.microsoft.com/en-us/download/dotnet/6.0){ .md-button .md-button--primary}
19 |
20 | ---
21 |
22 | ## Linux setup instructions
23 |
24 | ### Pre-requisites
25 |
26 | - ***Bottles*** - https://usebottles.com/
27 | - ***Stoneshard*** - The Windows version of Stoneshard must be used as the native Linux version is bundled differently
28 |
29 | ### Steps
30 | 1. Create a Bottle environment for gaming
31 |
32 | 
33 | 2. Open the newly created bottle and click "Add Shortcut" and browse to then select the `ModShardLauncher.exe`
34 | 3. Modify the newly added item by clicking the three dot menu and going to "Change Launch Options".
35 | The working directory must be updated to the directory that `ModShardLauncher.exe` resides in.
36 | 4. The bottle settings need to be updated to support the .NET environment. This can be found below the "Add Shortcut"
37 | button, select "Settings" and then "Environment Variables". A new variable needs to be added to handle the
38 | extraction location `DOTNET_BUNDLE_EXTRACT_BASE_DIR=Z:\home\{user}\dotnet_bundle_extract`, update this to a path of your choosing.
39 |
40 | *If you run into file permission issues with Bottles this is due to it running in a flatpak.
41 | I suggest using [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal) to give Bottles access to the required paths.*
42 | ---
43 |
44 | ## ModShardLauncher Setup
45 |
46 | ???+ warning "IMPORTANT - Installing after RtR"
47 | Make sure you are on the `modbranch` beta of Stoneshard on Steam before proceeding below.
48 | When launching the game, the version at the top right should say `X.X.X.X-vm`.
49 |
50 | Here's how to do it :
51 | - Right click on Stoneshard in your library on steam.
52 | - Click `Properties`.
53 | - Go in the `Betas` tab.
54 | - Select the `modbranch` beta.
55 | - Steam will now update your game files, when it's done, proceed below.
56 |
57 | - **Extract** `ModShardLauncher.zip` anywhere.
58 | - **Rename** `data.win` to `vanilla.win` in your Stoneshard folder.
59 | - **Run** `ModShardLauncher.exe`.
60 |
61 | ---
62 |
63 | ## UI Tour
64 |
65 | Let's take a quick tour of the UI to better know MSL.
66 |
67 | {: style="width:50%"}
68 |
69 |
70 | The button on the top left of the window shows the button's name.
71 | The `Anvil` button below that leads to the `Mods` menu. (***^^This is the only menu you will need^^***.)
72 | The `C#` button leads to the `Mod Sources` menu. (*It's used by modders to create their mods*.)
73 | The `Cog` button leads to the `Settings` menu. (*It's used for some settings you probably won't need*.)
74 |
75 |
76 | ---
77 |
78 | ## Installing a Mod
79 |
80 | Now that we've got MSL running, let's install some mods.
81 | Here's an [example video showing the installation](https://www.youtube.com/watch?v=_J0oJYGi38E&t=13s) of [NeoConsole](https://github.com/Nylux/Stoneshard-NeoConsole/releases). (*enable the subtitles !*)
82 | Note: It's a bit outdated, but the process is pretty much the same, a new video will be made at some point.
83 |
84 | ???+ warning "MAKE SURE YOU ARE ON THE MODBRANCH BETA OF STONESHARD ON STEAM"
85 |
86 | - Close MSL.
87 | - Download your mod's `.sml` file.
88 | - Place the `.sml` file in MSL's `Mods` folder.
89 | - Start MSL.
90 | - Click on the **anvil button** to open the `Mods` menu.
91 | - At the top left of the window, click on the **folder button**.
92 | - Select the `vanilla.win` file in the `Stoneshard` folder
93 | - In the `Mods` menu, **tick the box** next to the mods you wish to enable.
94 | - Click on the **save button** and save under any name (eg. `modded.win`)
95 | - Close MSL.
96 | - Start **Stoneshard**. It should ask you to select a `.win` file.
97 | - Select the `modded.win` file and enjoy your mods !
98 |
99 |
100 |
--------------------------------------------------------------------------------
/Controls/Settings.xaml:
--------------------------------------------------------------------------------
1 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
18 |
19 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
--------------------------------------------------------------------------------
/ModUtils/TableUtils/Drops.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Diagnostics.CodeAnalysis;
4 | using System.Linq;
5 | using System.Runtime.Serialization;
6 | using Serilog;
7 | using Serilog.Debugging;
8 |
9 | namespace ModShardLauncher;
10 |
11 | [SuppressMessage("ReSharper", "InconsistentNaming")]
12 | public partial class Msl
13 | {
14 | private static string EqTypeParser(HashSet eqTypes)
15 | {
16 | string eqTypesStr = "";
17 | foreach (DropsEqType t in eqTypes)
18 | eqTypesStr += $"{GetEnumMemberValue(t)}, ";
19 | eqTypesStr = eqTypesStr.TrimEnd(',', ' ');
20 | return eqTypesStr;
21 | }
22 |
23 | public enum DropsHook
24 | {
25 | CRYPTS,
26 | CATACOMBS,
27 | BASTIONS,
28 | OTHER
29 | }
30 |
31 | public enum DropsTier
32 | {
33 | [EnumMember(Value = "1")]
34 | Tier1,
35 | [EnumMember(Value = "2")]
36 | Tier2,
37 | [EnumMember(Value = "3")]
38 | Tier3,
39 | [EnumMember(Value = "4")]
40 | Tier4,
41 | [EnumMember(Value = "5")]
42 | Tier5
43 | }
44 |
45 | [Flags]
46 | public enum DropsSlotTags
47 | {
48 | raw = 1,
49 | common = 2
50 | }
51 |
52 | public enum DropsEqType
53 | {
54 | weapon,
55 | dagger,
56 | [EnumMember(Value = "2HStaff")]
57 | TwoHandedStaff,
58 | Chest,
59 | Legs,
60 | Waist,
61 | Arms,
62 | Head,
63 | jewelry,
64 | sword,
65 | mace,
66 | axe,
67 | spear,
68 | crossbow
69 | }
70 |
71 | [Flags]
72 | public enum DropsEqTags
73 | {
74 | aldor = 1,
75 | magic = 2,
76 | elven = 4,
77 | unique = 8
78 | }
79 |
80 | [Flags]
81 | public enum DropsEqRarity
82 | {
83 | common = 1,
84 | uncommon = 2,
85 | rare = 4,
86 | unique = 8
87 | }
88 |
89 | public record DropsSlot(string id, DropsSlotTags? tags, string count, byte chance);
90 | public record DropsEq(HashSet types, DropsEqTags tags, DropsEqRarity? rarity, string dur, byte chance);
91 |
92 | public static void InjectTableDrops(
93 | DropsHook hook,
94 | string id,
95 | DropsTier tier,
96 | HashSet? tierMod = null,
97 | DropsSlot? slot_1 = null,
98 | DropsSlot? slot_2 = null,
99 | DropsSlot? slot_3 = null,
100 | DropsSlot? slot_4 = null,
101 | DropsSlot? slot_5 = null,
102 | DropsSlot? slot_6 = null,
103 | DropsSlot? slot_7 = null,
104 | DropsSlot? slot_8 = null,
105 | DropsSlot? slot_9 = null,
106 | DropsEq? eq_1 = null,
107 | DropsEq? eq_2 = null,
108 | DropsEq? eq_3 = null,
109 | DropsEq? eq_4 = null,
110 | DropsEq? eq_5 = null
111 | )
112 | {
113 | // Table filename
114 | const string tableName = "gml_GlobalScript_table_drops";
115 |
116 | // Load table if it exists
117 | List table = ThrowIfNull(ModLoader.GetTable(tableName));
118 |
119 | // Parse tier
120 | string tierModStr = "";
121 | if (tierMod != null)
122 | {
123 | foreach (SurfaceSpawnTier t in tierMod)
124 | tierModStr += $"{GetEnumMemberValue(t)}, ";
125 | tierModStr = tierModStr.TrimEnd(',', ' ');
126 | }
127 |
128 | // Prepare line
129 | string newline = $"{id};{GetEnumMemberValue(tier)};{tierModStr};{slot_1?.id};{slot_1?.tags};{slot_1?.count};{slot_1?.chance};;{slot_2?.id};{slot_2?.tags};{slot_2?.count};{slot_2?.chance};;{slot_3?.id};{slot_3?.tags};{slot_3?.count};{slot_3?.chance};;{slot_4?.id};{slot_4?.tags};{slot_4?.count};{slot_4?.chance};;{slot_5?.id};{slot_5?.tags};{slot_5?.count};{slot_5?.chance};;{slot_6?.id};{slot_6?.tags};{slot_6?.count};{slot_6?.chance};;{slot_7?.id};{slot_7?.tags};{slot_7?.count};{slot_7?.chance};;{slot_8?.id};{slot_8?.tags};{slot_8?.count};{slot_8?.chance};;{slot_9?.id};{slot_9?.tags};{slot_9?.count};{slot_9?.chance};;{(eq_1 != null ? EqTypeParser(eq_1.types) : "")};{eq_1?.tags};{eq_1?.rarity};{eq_1?.dur};{eq_1?.chance};;{(eq_2 != null ? EqTypeParser(eq_2.types) : "")};{eq_2?.rarity};{eq_2?.dur};{eq_2?.chance};;{(eq_3 != null ? EqTypeParser(eq_3.types) : "")};{eq_3?.rarity};{eq_3?.dur};{eq_3?.chance};;{(eq_4 != null ? EqTypeParser(eq_4.types) : "")};{eq_4?.rarity};{eq_4?.dur};{eq_4?.chance};;{(eq_5 != null ? EqTypeParser(eq_5.types) : "")};{eq_5?.rarity};{eq_5?.dur};{eq_5?.chance};";
130 |
131 | // Find hook
132 | string hookStr = "// " + hook;
133 | (int ind, string? foundLine) = table.Enumerate().FirstOrDefault(x => x.Item2.Contains(hookStr));
134 |
135 | // Add line to table
136 | if (foundLine != null)
137 | {
138 | table.Insert(ind + 1, newline);
139 | ModLoader.SetTable(table, tableName);
140 | Log.Information("Injected Drop {0} into table {1} under {2}", id, tableName, hook);
141 | }
142 | else
143 | {
144 | Log.Error("Cannot find hook {0} in table {1}", hook, tableName);
145 | throw new Exception($"Cannot find hook {hook} in table {tableName}");
146 | }
147 | }
148 | }
--------------------------------------------------------------------------------
/Core/UI/ErrorMessageDialog.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Drawing;
3 | using System.Windows.Forms;
4 | using Serilog;
5 |
6 | namespace ModShardLauncher.Core.UI
7 | {
8 | public class ErrorMessageDialog : Form
9 | {
10 | private readonly RichTextBox messageTextBox;
11 | public DialogResult Result { get; private set; }
12 | private readonly TableLayoutPanel panel;
13 | private readonly Button okButton;
14 | private readonly Button cpyButton;
15 | private readonly Button logButton;
16 | public ErrorMessageDialog(string title, string message, string? logPath = null)
17 | {
18 | panel = new();
19 | messageTextBox = new RichTextBox();
20 | okButton = new Button();
21 | cpyButton = new Button();
22 | logButton = new Button();
23 |
24 | InitializeComponent();
25 | SetupDialog(title, message, logPath);
26 | }
27 | private void InitializeComponent()
28 | {
29 | SuspendLayout();
30 |
31 | Text = string.Empty;
32 | Size = new Size(450, 200);
33 | StartPosition = FormStartPosition.CenterParent;
34 | FormBorderStyle = FormBorderStyle.FixedDialog;
35 | MaximizeBox = false;
36 | MinimizeBox = false;
37 | ShowIcon = false;
38 | ShowInTaskbar = false;
39 | Dock = DockStyle.Fill;
40 |
41 | // panel
42 | panel.Anchor = AnchorStyles.Top;
43 | panel.Size = new Size(300, 150);
44 | panel.BorderStyle = BorderStyle.None;
45 | panel.ColumnCount = 3;
46 | panel.RowCount = 2;
47 | panel.RowStyles.Add(new RowStyle(SizeType.AutoSize));
48 | panel.RowStyles.Add(new RowStyle(SizeType.Absolute, 44));
49 | panel.ColumnStyles.Add(new ColumnStyle(SizeType.Percent, 100));
50 | panel.ColumnStyles.Add(new ColumnStyle(SizeType.AutoSize));
51 | panel.ColumnStyles.Add(new ColumnStyle(SizeType.AutoSize));
52 | panel.Dock = DockStyle.Fill;
53 |
54 | // Message TextBox
55 | messageTextBox.ReadOnly = true;
56 | messageTextBox.BorderStyle = BorderStyle.None;
57 | messageTextBox.BackColor = BackColor;
58 | messageTextBox.ScrollBars = RichTextBoxScrollBars.Vertical;
59 | messageTextBox.TabStop = false;
60 |
61 | // ok button
62 | okButton.Text = "OK";
63 | okButton.Size = new Size(75, 23);
64 | okButton.DialogResult = DialogResult.OK;
65 | okButton.Click += (s, e) => { Result = DialogResult.OK; Close(); };
66 |
67 | // copy button
68 | cpyButton.Text = "Copy error";
69 | cpyButton.Size = new Size(100, 23);
70 | cpyButton.Click += CopyButton_Click;
71 |
72 | // log button
73 | logButton.Text = "Open Log Folder";
74 | logButton.Size = new Size(120, 23);
75 | logButton.Click += LogButton_Click;
76 |
77 | panel.Controls.Add(messageTextBox, 0, 0);
78 | panel.SetColumnSpan(messageTextBox, 3);
79 | panel.Controls.Add(okButton, 0, 1);
80 | panel.Controls.Add(cpyButton, 1, 1);
81 | panel.Controls.Add(logButton, 2, 1);
82 |
83 | Controls.Add(panel);
84 |
85 | // Set default button and cancel button
86 | AcceptButton = okButton;
87 | CancelButton = okButton;
88 |
89 | ResumeLayout();
90 | }
91 | private void SetupDialog(string title, string message, string? logPath = null)
92 | {
93 | Text = title;
94 | messageTextBox.Rtf = message;
95 | messageTextBox.AutoSize = true;
96 |
97 | Size size = messageTextBox.GetPreferredSize(new Size(800, 0)) + new Size(0, 50);
98 | int newHeight = size.Height + 100;
99 | int newWidth = Math.Max(450, size.Width + 50);
100 |
101 | messageTextBox.Size = new Size(size.Width, size.Height);
102 | Size = new Size(newWidth, newHeight);
103 |
104 | // Hide log button if no path provided
105 | if (string.IsNullOrEmpty(logPath))
106 | {
107 | logButton.Visible = false;
108 | okButton.Location = new Point(340, 125); // Center the OK button
109 | }
110 | else
111 | {
112 | logButton.Tag = logPath; // Store the log path
113 | }
114 | }
115 | private void LogButton_Click(object? sender, EventArgs e)
116 | {
117 | try
118 | {
119 | string? logPath = logButton.Tag?.ToString();
120 | if (!string.IsNullOrEmpty(logPath))
121 | {
122 | System.Diagnostics.Process.Start("explorer.exe", logPath);
123 | }
124 | }
125 | catch (Exception ex)
126 | {
127 | MessageBox.Show($"Could not open log folder: {ex.Message}", "Error", MessageBoxButtons.OK, MessageBoxIcon.Warning);
128 | }
129 |
130 | // nifty trick: use Retry to indicate log button was clicked
131 | Result = DialogResult.Retry;
132 | Close();
133 | }
134 | private void CopyButton_Click(object? sender, EventArgs e)
135 | {
136 | Clipboard.SetText(messageTextBox.Text);
137 | }
138 | public static DialogResult Show(string title, string message, string? logPath = null)
139 | {
140 | using var dialog = new ErrorMessageDialog(title, message, logPath);
141 | dialog.ShowDialog();
142 | return dialog.Result;
143 | }
144 | }
145 | }
--------------------------------------------------------------------------------
/docs/guides/start-modding.zh.md:
--------------------------------------------------------------------------------
1 | # 开始吧!
2 |
3 | [TOC]
4 |
5 | ## C#基础
6 |
7 | 如果你想要制作mod, 那请确保你有一定的C#基础, 不然你可能会看不懂工具的API是怎么用的.
8 |
9 | ## 下载工具
10 |
11 | 要想制作mod, 你首先需要一个写代码的工具.
12 |
13 | 比如**Visual Studio**, 这是一款很专业的开发工具, 你可以用它方便地开发mod.
14 |
15 | [在这里下载](https://visualstudio.microsoft.com/)
16 |
17 | 在下载时, 确保你选择了 `.NET Desktop Development` 工作负载. 其他的负载可以不用下载.
18 |
19 | 最后, 到微软官网查找 `.NET 6.0 SDK` 来下载安装包. 然后重启你的电脑来应用这些更改.
20 |
21 | 另一个选择是**Visual Studio Code**, 在我看来其实用VSCode就足以制作StoneShard的mod了.
22 |
23 | 对于**Visual Studio Code**的教程, 请移步[这里](../guides/start-modding-with-vsc.md)
24 |
25 | ## 创建你的第一个mod
26 |
27 | 首先, 你需要启动 **ModShardLauncher.exe** , 启动之后它会在根目录下创建两个文件夹,
28 | 一个是Mods, 另一个是ModSources.
29 |
30 | 然后在ModSources文件夹中创建一个新的文件夹, 你的第一个mod就从这里开始了.
31 |
32 | ### 创建mod!
33 |
34 | 创建mod的方式有很多, 我们先来拿**Visual Studio**举例.
35 | 首先运行VS, 点击创建新项目, 搜索类库并单击下一步. 如图:
36 | {: style="width:50%"}
37 |
38 | 然后输入你mod的名字, 选择路径为刚才 **ModShardLauncher.exe** 创建的 Mods 文件夹.
39 | {: style="width:50%"}
40 |
41 | 最后选择 .Net 6.0即可
42 | {: style="width:50%"}
43 |
44 | ### 程序集引用!
45 |
46 | 首先我们需要引用工具的程序集, 即Dll文件.
47 |
48 | 先打开解决方案资源管理器.
49 | {: style="width:50%"}
50 |
51 | 右键依赖项, 并单击添加项目引用.
52 | {: style="width:50%"}
53 |
54 | 点击浏览.
55 | {: style="width:50%"}
56 |
57 | 最后选择ModShardLauncher.dll并点击添加.
58 | {: style="width:50%"}
59 |
60 | ### Mod主类!
61 |
62 | 如果你有C#基础, 那你一定对 **类**(Class) 有了解.我们接下来就要创建一个Mod的主类.
63 |
64 | 创建项目时, VS应该已经为我们创建了一个类, 名字叫做Class1. 我们要做的就是先添加对 `ModShardLauncher` 和 `ModShardLauncher.Mods` 这两个命名空间的引用. 然后将代码改成如下这样:
65 | {: style="width:50%"}
66 |
67 |
68 | 可以看到我们先是把类的访问级别从 `internal` 改为了 `public` , 这样一来Mod加载时就可以读取到这个类. 然后我们把类名改成了 `MyFirstMod` , 并让这个类继承 `Mod` 类.
69 |
70 | ### Mod信息!
71 |
72 | 接下来我们给Mod添加基础的信息.
73 |
74 | 在 `MyFirstMod` 类中添加如下代码:
75 | ```C#
76 | public override string Name => "MyFirstMod";
77 | public override string Author => "Mantodea";
78 | public override string Description => "我的第一个mod";
79 | ```
80 | 这样我们就设置了mod的名称, 作者与描述信息.
81 |
82 | ### 编译Mod!
83 |
84 | 接下来我们启动**ModShardLauncher**. 可以看到我们的Mod源码已经被加载出来了.
85 | {: style="width:50%"}
86 |
87 | 在编译mod之前, 我们需要先点击模组界面左上角的文件夹按钮, 并选择 **原版** 的data.win文件进行加载.
88 |
89 | ??? reason "为什么要使用原版文件?"
90 |
91 | 这个工具是基于data.win文件内的各种信息的名称来工作的, 如果你已经加入了源码mod, 很可能会出现各种崩溃的情况.
92 |
93 | ??? reason "为什么要加载游戏文件才能编译?"
94 |
95 | 为了获取游戏版本, 防止极小可能出现的版本不同而崩溃现象(确信)
96 |
97 | 然后我们就可以点击 `MyFirstMod` 栏位右下角的编译辣! (UI现在嘎嘎好看是不是)
98 |
99 | 编译成功后的结果:
100 | {: style="width:50%"}
101 |
102 | ## 创建你的第一把武器
103 |
104 | 就在刚刚, 你的第一个mod已经成功编译了! 接下来, 让我们为它添加一些看得到的东西吧.
105 |
106 | ### 创建武器类!
107 |
108 | 首先点击右侧的解决方案资源管理器, 然后右键你的项目, 点击添加, 最后点击新建项, 如图:
109 | {: style="width:50%"}
110 |
111 | 名字就输入这把武器的名称即可, 这里我们使用 `MyFirstWeapon` 作为它的名字.
112 |
113 | 接下来进入代码界面, 还是一样的操作, 将 `internal` 改为 `public` , 以便Mod加载时可以加载到这把武器的信息. 然后添加对 `ModShardLauncher` 和 `ModShardLauncher.Mods` 这两个命名空间的引用. 并让武器类继承 `Weapon` 类.
114 |
115 | ### 修改武器的信息!
116 |
117 | 玩过紫晶的人都知道, 紫晶里的武器属性很多. 挨个设置不仅麻烦, 还会很痛苦, 而且还有可能落下某些属性, 导致mod没法正常加载.
118 |
119 | ??? why "你知道的太多了"
120 | ~~实际上是因为毛子写的代码很傻逼.~~
121 |
122 | 那么有没有一种办法可以让我们简单快捷的设置一把武器的属性呢?
123 |
124 | 首先我们添加如下代码来重写 `SetDefaults` 方法.
125 | ```C#
126 | public override void SetDefaults()
127 | {
128 |
129 | }
130 | ```
131 | ??? why "你知道的太多了"
132 | ~~有种tModLoader的风格, 我已经被荼毒了.~~
133 |
134 | 看英文可以知道, 这个方法用于在加载武器时设定它的属性.
135 |
136 | 接下来我们隆重介绍---- **`CloneDefaults`** 方法!
137 |
138 | 没错, 为了防止玩家累死(不是) 我们modder开发时经常忘记各种属性, 我提供了一个方法来让当前这把武器的除 `Name` 与 `ID` 两个属性之外的所有属性全部照抄另外一把原版武器----**`CloneDefaults`**! 因此, 只需把代码改成这样:
139 | ```C#
140 | public override void SetDefaults()
141 | {
142 | CloneDefaults("Homemade Blade");
143 | Name = "MyFirstWeapon";
144 | ID = "MyFirstMod1";
145 | }
146 | ```
147 |
148 | 这样一来, 这把武器就变成了一把除了名字不一样其他全部一样的换皮土刀(有种NTR的感觉)
149 |
150 | 但是需要注意的是, `CloneDefaults` 并不会对武器的各种语言名称和介绍进行赋值, 这些仍然需要你手动修改. 因此我们再加上两行:
151 |
152 | ```C#
153 | public override void SetDefaults()
154 | {
155 | CloneDefaults("Homemade Blade");
156 | Name = "MyFirstWeapon";
157 | ID = "MyFirstMod1";
158 | Description[ModLanguage.Chinese] = "这是我的第一把武器";
159 | NameList[ModLanguage.Chinese] = "我的神剑咖喱棒";
160 | }
161 | ```
162 |
163 | 这样一来我们的第一把武器算是初步完成了.
164 |
165 | ### 武器贴图!
166 |
167 | StoneShard做mod最痛苦的一部分就是这里了. 贴图, 一把最基础的武器竟然需要六张贴图, 这无疑增加了modder的工作量.
168 |
169 | 如果你没得贴图, 你可以使用UTMT对原版的贴图进行导出, 然后放在Mod目录除 `.vs, bin 和 obj` 的任何地方, 打包时会自动将他们打包进data.win的.
170 | {: style="width:50%"}
171 |
172 | 如图所示, 从上到下依次是: 人物右手拿武器, 人物左手拿武器, 背包中的武器(有三张的原因是紫晶的武器有破损系统, 如果你不想画, 可以把完整版的武器复制三遍), 掉落的武器.
173 |
174 | ??? why "注意"
175 | 武器在背包中的贴图长宽必须是27的倍数, 这是因为紫晶的背包一格为27*27
176 |
177 | 以上这张图只针对单手武器, 如果是双手武器, 则只需要char而不需要char_left, 因为双手武器只有一种拿取方式.
178 |
179 | 准备好所有这些东西后, 你就可以再次打开 **ModShardLauncher.exe** 重复之前的编译步骤.
180 |
181 | ### 加载Mod!
182 |
183 | !!! notice "**注意!!!**"
184 | 有一点很重要, 你需要把工具目录下一个叫做 `ModShard.dll` 的文件移动到游戏的根目录, 他是该工具内置的一个游戏插件. 否则你将无法启动游戏!
185 |
186 | 最后一步, 也就是加载Mod了, 在你编译完mod之后, 你会发现上方的模组界面中多出了你的mod, 选择它右下角的启用. 最后点击左上角的保存按钮, 就可以把mod数据打包进你刚才加载的那个原版data.win了. 把打包好的数据随便存在什么地方, 把原版的data.win挪走, 再进入游戏, 就会提示你选择数据文件. 选择我们刚才保存的那个数据文件即可.
187 |
188 | ### 进入游戏!
189 |
190 | 打开游戏后, 你会发现打开了一个除游戏之外的窗口, 那是刚才的插件打开的, 它的作用是类似于一个控制台, 可以在游戏过程中运行一些内置函数.(如果没打开记得联系我 一定是哪里出问题了)
191 |
192 | 正常进入游戏, 插件内置了一个give函数, 你可以在插件窗口的下方 `Script` 文本框中输入
193 | ```
194 | give MyFirstWeapon
195 | ```
196 | 来获取刚才那把mod武器.
197 |
198 | 如果你想用这个功能获取其他武器, 请注意把武器名中的空格改为 `_` , 如:
199 | ```
200 | give Homemade_Blade
201 | ```
202 |
203 | 执行了give函数后, 可以发现背包中就多了一把mod武器了.
204 | {: style="width:50%"}
--------------------------------------------------------------------------------
/ModUtils/TextureUtils.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using Serilog;
5 | using UndertaleModLib;
6 | using UndertaleModLib.Models;
7 |
8 | namespace ModShardLauncher
9 | {
10 | public class RectTexture
11 | {
12 | public ushort X;
13 | public ushort Y;
14 | public ushort Width;
15 | public ushort Height;
16 |
17 | public RectTexture(ushort x, ushort y, ushort width, ushort height)
18 | {
19 | X = x;
20 | Y = y;
21 | Width = width;
22 | Height = height;
23 | }
24 | }
25 | public class MarginData
26 | {
27 | public int Top;
28 | public int Bottom;
29 | public int Left;
30 | public int Right;
31 |
32 | public MarginData(int top, int bottom, int left, int right)
33 | {
34 | Top = top;
35 | Bottom = bottom;
36 | Left = left;
37 | Right = right;
38 | }
39 | }
40 | public class BoundingData
41 | {
42 | public T Width;
43 | public T Height;
44 |
45 | public BoundingData(T width, T height)
46 | {
47 | Width = width;
48 | Height = height;
49 | }
50 | }
51 | public class OriginData
52 | {
53 | public int X;
54 | public int Y;
55 |
56 | public OriginData(int x, int y)
57 | {
58 | X = x;
59 | Y = y;
60 | }
61 | }
62 | public static partial class Msl
63 | {
64 | public static UndertaleTexturePageItem CreateTexureItem(UndertaleEmbeddedTexture texture, RectTexture source, RectTexture target, BoundingData bounding)
65 | {
66 | return new()
67 | {
68 | Name = ModLoader.Data.Strings.MakeString("PageItem " + ModLoader.Data.TexturePageItems.Count),
69 |
70 | SourceX = source.X,
71 | SourceY = source.Y,
72 | SourceHeight = source.Height,
73 | SourceWidth = source.Width,
74 |
75 | TargetX = target.X,
76 | TargetY = target.Y,
77 | TargetHeight = target.Height,
78 | TargetWidth = target.Width,
79 |
80 | BoundingHeight = bounding.Height,
81 | BoundingWidth = bounding.Width,
82 | TexturePage = texture
83 | };
84 | }
85 | public static UndertaleSprite CreateSpriteNoCollisionMasks(string spriteName, MarginData margin, OriginData origin, BoundingData bounding)
86 | {
87 | UndertaleSprite newSprite = new()
88 | {
89 | Name = ModLoader.Data.Strings.MakeString(spriteName),
90 | Width = bounding.Width,
91 | Height = bounding.Height,
92 | MarginLeft = margin.Left,
93 | MarginRight = margin.Right,
94 | MarginTop = margin.Top,
95 | MarginBottom = margin.Bottom,
96 | OriginX = origin.X,
97 | OriginY = origin.Y,
98 | };
99 |
100 | return newSprite;
101 | }
102 | public static UndertaleSprite GetSprite(string name)
103 | {
104 | UndertaleSprite sprite = ModLoader.Data.Sprites.First(t => t.Name.Content == name);
105 | Log.Information("Found sprite: {0}", name);
106 | return sprite;
107 | }
108 | public static UndertaleEmbeddedTexture GetEmbeddedTexture(string name)
109 | {
110 | UndertaleEmbeddedTexture embeddedTexture = ModLoader.Data.EmbeddedTextures.First(t => t.Name.Content == name);
111 | Log.Information("Found embedded texture: {0}", name);
112 | return embeddedTexture;
113 | }
114 | public static UndertaleTexturePageItem GetTexturePageItem(string name)
115 | {
116 | UndertaleTexturePageItem texturePageItem = ModLoader.Data.TexturePageItems.First(t => t.Name.Content == name);
117 | Log.Information("Found texture page item: {0}", name);
118 | return texturePageItem;
119 | }
120 | public static string AddNewTexturePageItem(string embeddedTextureName, RectTexture source, RectTexture target, BoundingData bounding)
121 | {
122 | UndertaleEmbeddedTexture embeddedTexture = GetEmbeddedTexture(embeddedTextureName);
123 |
124 | UndertaleTexturePageItem texturePageItem = CreateTexureItem(
125 | embeddedTexture,
126 | source,
127 | target,
128 | bounding
129 | );
130 | ModLoader.Data.TexturePageItems.Add(texturePageItem);
131 | Log.Information("Successfully added a new texture from: {0}", embeddedTextureName);
132 | return texturePageItem.Name.Content;
133 | }
134 | public static string AddNewSprite(string spriteName, List texturePageItemNames, MarginData margin, OriginData origin, BoundingData bounding)
135 | {
136 | UndertaleSprite newSprite = CreateSpriteNoCollisionMasks(
137 | spriteName,
138 | margin,
139 | origin,
140 | bounding
141 | );
142 |
143 | IEnumerable texturePageItems = texturePageItemNames
144 | .Select(x => GetTexturePageItem(x))
145 | .Select(x => new UndertaleSprite.TextureEntry(){ Texture = x });
146 |
147 | foreach(UndertaleSprite.TextureEntry texturePageItem in texturePageItems)
148 | {
149 | newSprite.Textures.Add(texturePageItem);
150 | }
151 |
152 | ModLoader.Data.Sprites.Add(newSprite);
153 |
154 | Log.Information("Successfully added new sprite: {0}", newSprite.Name.Content);
155 | return newSprite.Name.Content;
156 | }
157 | }
158 | }
--------------------------------------------------------------------------------
/ModUtils/TableUtils/SkillsStats.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Diagnostics.CodeAnalysis;
4 | using System.Linq;
5 | using System.Runtime.Serialization;
6 | using Serilog;
7 |
8 | namespace ModShardLauncher;
9 |
10 | [SuppressMessage("ReSharper", "InconsistentNaming")]
11 | [SuppressMessage("ReSharper", "IdentifierTypo")]
12 | public partial class Msl
13 | {
14 | public enum SkillsStatsHook
15 | {
16 | BASIC,
17 | RANGED,
18 | SWORDS,
19 | [EnumMember(Value = "2H SWORDS")]
20 | TWOHANDEDSWORDS,
21 | [EnumMember(Value = "2H MACES")]
22 | TWOHANDEDMACES,
23 | [EnumMember(Value = "2H AXES")]
24 | TWOHANDEDAXES,
25 | AXES,
26 | MACES,
27 | STAVES,
28 | SHIELDS,
29 | DAGGERS,
30 | [EnumMember(Value = "DUAL WIELDING")]
31 | DUALWIELDING,
32 | SPEARS,
33 | COMBAT,
34 | ATHLETICS,
35 | SURVIVAL,
36 | PYRO,
37 | GEO,
38 | ELECTRO,
39 | ARMOR,
40 | [EnumMember(Value = "MAGIC MASTERY")]
41 | MAGICMASTERY,
42 | UNDEAD,
43 | [EnumMember(Value = "PROLOGUE STATUES")]
44 | PROLOGUESTATUES,
45 | [EnumMember(Value = "PROLOGUE ARCHON")]
46 | PROLOGUEARCHON,
47 | PROSELYTES,
48 | BRIGANDS,
49 | [EnumMember(Value = "ANCIENT TROLL")]
50 | ANCIENTTROLL,
51 | BEASTS,
52 | MANTICORE
53 | }
54 |
55 | public enum SkillsStatsTarget
56 | {
57 | [EnumMember(Value = "No Target")]
58 | NoTarget,
59 | [EnumMember(Value = "Target Object")]
60 | TargetObject,
61 | [EnumMember(Value = "Target Point")]
62 | TargetPoint,
63 | [EnumMember(Value = "Target Area")]
64 | TargetArea,
65 | [EnumMember(Value = "Target Ally")]
66 | TargetAlly
67 | }
68 |
69 | public enum SkillsStatsPattern
70 | {
71 | normal,
72 | five,
73 | line,
74 | circle,
75 | pyramid,
76 | pyramid_shift
77 | }
78 |
79 | public enum SkillsStatsValidator
80 | {
81 | [EnumMember(Value = "")]
82 | none,
83 | AVOID_TILEMARKS,
84 | DASH
85 | }
86 |
87 | public enum SkillsStatsClass
88 | {
89 | skill,
90 | spell,
91 | attack,
92 | }
93 |
94 | public enum SkillsStatsBranch
95 | {
96 | none, // For some reason the string none has to be written, rather than leaving the field empty. Inconsistent but it is what it is.
97 | ranged,
98 | sword,
99 | [EnumMember(Value = "2hsword")]
100 | two_handed_sword,
101 | [EnumMember(Value = "2hmace")]
102 | two_handed_mace,
103 | [EnumMember(Value = "2haxe")]
104 | two_handed_axe,
105 | axe,
106 | mace,
107 | staff,
108 | shield,
109 | dagger,
110 | dual,
111 | spear,
112 | combat,
113 | athletic,
114 | pyromancy,
115 | geomancy,
116 | electromancy,
117 | armor,
118 | magic_mastery,
119 | necromancy,
120 | sanguimancy
121 | }
122 |
123 | public enum SkillsStatsMetacategory
124 | {
125 | [EnumMember(Value = "")]
126 | none,
127 | weapon,
128 | utility
129 | }
130 |
131 | public static void InjectTableSkillsStats(
132 | SkillsStatsHook hook,
133 | string id,
134 | string? Object = null,
135 | SkillsStatsTarget Target = SkillsStatsTarget.NoTarget,
136 | string Range = "0",
137 | ushort KD = 0,
138 | ushort MP = 0,
139 | ushort Reserv = 0,
140 | ushort Duration = 0,
141 | byte AOE_Lenght = 0,
142 | byte AOE_Width = 0,
143 | bool is_movement = false,
144 | SkillsStatsPattern Pattern = SkillsStatsPattern.normal,
145 | SkillsStatsValidator Validators = SkillsStatsValidator.none,
146 | SkillsStatsClass Class = SkillsStatsClass.skill,
147 | bool Bonus_Range = false, // could be byte ? Not sure as only values are 0 and 1
148 | string? Starcast = null,
149 | SkillsStatsBranch Branch = SkillsStatsBranch.none,
150 | bool is_knockback = false,
151 | bool Crime = false,
152 | SkillsStatsMetacategory metacategory = SkillsStatsMetacategory.none,
153 | short FMB = 0,
154 | string AP = "x",
155 | bool Attack = false,
156 | bool Stance = false,
157 | bool Charge = false,
158 | bool Maneuver = false,
159 | bool Spell = false
160 | )
161 | {
162 | // Table filename
163 | const string tableName = "gml_GlobalScript_table_skills_stats";
164 |
165 | // Load table if it exists
166 | List table = ThrowIfNull(ModLoader.GetTable(tableName));
167 |
168 | // Prepare line
169 | string newline = $"{id};{Object};{GetEnumMemberValue(Target)};{Range};{KD};{MP};{Reserv};{Duration};{AOE_Lenght};{AOE_Width};{(is_movement ? "1" : "0")};{Pattern};{GetEnumMemberValue(Validators)};{Class};{(Bonus_Range ? "1" : "0")};{Starcast};{GetEnumMemberValue(Branch)};{(is_knockback ? "1" : "0")};{(Crime ? "1" : "")};{GetEnumMemberValue(metacategory)};{FMB};{AP};{(Attack ? "1" : "")};{(Stance ? "1" : "")};{(Charge ? "1" : "")};{(Maneuver ? "1" : "")};{(Spell ? "1" : "")};";
170 |
171 | // Find Hook
172 | string hookStr = "// " + GetEnumMemberValue(hook);
173 | (int ind, string? foundLine) = table.Enumerate().FirstOrDefault(x => x.Item2.Contains(hookStr));
174 |
175 | // Add line to table
176 | if (foundLine != null)
177 | {
178 | table.Insert(ind + 1, newline);
179 | ModLoader.SetTable(table, tableName);
180 | Log.Information("Injected Skill Stat {0} into {1} under {2}", id, tableName, hook);
181 | }
182 | else
183 | {
184 | Log.Error("Cannot find Hook {0} in table {1}", hook, tableName);
185 | throw new Exception($"Hook {hook} not found in table {tableName}");
186 | }
187 | }
188 | }
--------------------------------------------------------------------------------
/Controls/SourceBar.xaml:
--------------------------------------------------------------------------------
1 |
13 |
14 |
16 |
19 |
20 |
24 |
64 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
--------------------------------------------------------------------------------
/ModUtils/LootUtils.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using Serilog;
4 | using Newtonsoft.Json;
5 | using System.IO;
6 |
7 | namespace ModShardLauncher
8 | {
9 | public class ItemsTable
10 | {
11 | public string[] ListItems { get; }
12 | public int[] ListRarity { get; }
13 | public int[] ListDurability { get; }
14 | public ItemsTable()
15 | {
16 | ListItems = Array.Empty();
17 | ListRarity = Array.Empty();
18 | ListDurability = Array.Empty();
19 | }
20 | public ItemsTable(string[] listItems, int[] listRarity, int[] listDurability)
21 | {
22 | if (listItems.Length != listRarity.Length || listItems.Length != listDurability.Length)
23 | {
24 | throw new ArgumentException($"Error in ItemsTable constructor, {listItems}, {listRarity} and {listDurability} must have the same length.");
25 | }
26 | ListItems = listItems;
27 | ListRarity = listRarity;
28 | ListDurability = listDurability;
29 | }
30 | }
31 | public class RandomItemsTable
32 | {
33 | public int[] ListWeight { get; }
34 | public ItemsTable ItemsTable { get; }
35 | public RandomItemsTable(int[] listWeight, ItemsTable itemsTable)
36 | {
37 | if (listWeight.Length != itemsTable.ListItems.Length)
38 | {
39 | throw new ArgumentException($"Error in RandomItemsTable constructor, {listWeight}, and {itemsTable} elements must have the same length.");
40 | }
41 | ListWeight = listWeight;
42 | ItemsTable = itemsTable;
43 | }
44 | public RandomItemsTable(int[] listWeight, string[] listItems, int[] listRarity, int[] listDurability): this(listWeight, new ItemsTable(listItems, listRarity, listDurability)) { }
45 | }
46 | public class ReferenceTable
47 | {
48 | public string DefaultTable { get; }
49 | public Dictionary Ids { get; }
50 | public Dictionary Tiers { get; }
51 | public ReferenceTable(string defaultTable, Dictionary ids, Dictionary tiers)
52 | {
53 | DefaultTable = defaultTable;
54 | Ids = ids;
55 | Tiers = tiers;
56 | }
57 | }
58 | public class LootTable
59 | {
60 | public ItemsTable GuaranteedItems { get; }
61 | public int RandomLootMin { get; }
62 | public int RandomLootMax { get; }
63 | public int EmptyWeight { get; }
64 | public RandomItemsTable RandomItemsTable { get; }
65 | public LootTable(ItemsTable guaranteedItems, int randomLootMin, int randomLootMax, int emptyWeight, RandomItemsTable randomItemsTable)
66 | {
67 | GuaranteedItems = guaranteedItems;
68 | RandomLootMin = randomLootMin;
69 | RandomLootMax = randomLootMax;
70 | EmptyWeight = emptyWeight;
71 | RandomItemsTable = randomItemsTable;
72 | }
73 | }
74 | public static class LootUtils
75 | {
76 | internal static Dictionary ReferenceTables = new();
77 | internal static Dictionary LootTables = new();
78 | public static void ResetLootTables()
79 | {
80 | ReferenceTables.Clear();
81 | LootTables.Clear();
82 | }
83 | public static void SaveLootTables(string DirPath)
84 | {
85 | try
86 | {
87 | if (LootTables.Count > 0)
88 | {
89 | File.WriteAllText(Path.Combine(DirPath, "loot_table.json"), JsonConvert.SerializeObject(LootTables));
90 | Log.Information("Successfully saving the loot table json.");
91 | }
92 | if (ReferenceTables.Count > 0)
93 | {
94 | File.WriteAllText(Path.Combine(DirPath, "reference_table.json"), JsonConvert.SerializeObject(ReferenceTables));
95 | Log.Information("Successfully saving the reference table json.");
96 | }
97 | }
98 | catch (Exception ex)
99 | {
100 | Log.Error(ex, "Saving Loot table failed for {0}", DirPath);
101 | }
102 | }
103 | public static void InjectLootScripts()
104 | {
105 | if (LootTables.Count == 0 && ReferenceTables.Count == 0) return;
106 |
107 | Msl.AddInnerFunction("scr_msl_resolve_items");
108 | Msl.AddInnerFunction("scr_msl_resolve_refence_table");
109 | Msl.AddInnerFunction("scr_msl_resolve_guaranteed_items");
110 | Msl.AddInnerFunction("scr_msl_resolve_random_items");
111 | Msl.AddInnerFunction("scr_msl_resolve_loot_table");
112 |
113 | Msl.LoadGML("gml_Object_c_container_Other_10")
114 | .MatchFrom("script_execute")
115 | .InsertBelow("scr_msl_resolve_loot_table(other, 0)")
116 | .Save();
117 |
118 | Msl.LoadGML("gml_Object_o_unit_Destroy_0")
119 | .MatchAll()
120 | .InsertBelow("scr_msl_resolve_loot_table(self, 1)")
121 | .Save();
122 | }
123 | }
124 | public static partial class Msl
125 | {
126 | public static void AddLootTable(string lootTableID, ItemsTable guaranteedItems, int randomLootMin, int randomLootMax, int emptyWeight, RandomItemsTable randomItemsTable)
127 | {
128 | LootTable lootTable = new(guaranteedItems, randomLootMin, randomLootMax, emptyWeight, randomItemsTable);
129 | LootUtils.LootTables.Add(lootTableID, lootTable);
130 | Log.Information("Adding LootTable {0}", lootTableID);
131 | }
132 | public static void AddReferenceTable(string nameObject, string table)
133 | {
134 | LootUtils.ReferenceTables.Add(nameObject, new ReferenceTable(table, new Dictionary(), new Dictionary()));
135 | Log.Information("Adding ReferenceTable {0} for {1}", table, nameObject);
136 | }
137 | public static void AddReferenceTable(string nameObject, string table, Dictionary? ids, Dictionary? tiers)
138 | {
139 | LootUtils.ReferenceTables.Add(nameObject, new ReferenceTable(table, ids ?? new Dictionary(), tiers ?? new Dictionary()));
140 | Log.Information("Adding ReferenceTable {0} for {1}", table, nameObject);
141 | }
142 | public static void AddReferenceTableForMultipleObjects(string table, params string[] nameObjects)
143 | {
144 | foreach(string nameObject in nameObjects)
145 | {
146 | Msl.AddReferenceTable(nameObject, table);
147 | }
148 | }
149 | }
150 | }
--------------------------------------------------------------------------------
/Controls/ModBar.xaml:
--------------------------------------------------------------------------------
1 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
24 |
27 |
28 |
30 |
31 |
32 |
34 |
37 |
38 |
42 |
46 |
51 |
53 |
55 |
56 |
84 |
85 |
86 |
95 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
--------------------------------------------------------------------------------
/ModUtils/ObjectUtils.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Linq;
3 | using Serilog;
4 | using UndertaleModLib;
5 | using UndertaleModLib.Models;
6 |
7 | namespace ModShardLauncher
8 | {
9 | public static class GameObjectUtils
10 | {
11 | ///
12 | /// Extension method to apply several to a simultaneously. It is expected that all MslEvent.Code contain the path of their code.
13 | /// For example:
14 | ///
15 | /// gameObject.ApplyEvent(ModFiles,
16 | /// new MslEvent(fileName0, EventType.Create, 0),
17 | /// new MslEvent(fileName1, EventType.Other, 10),
18 | /// new MslEvent(fileName2, EventType.Other, 11)
19 | /// );
20 | ///
21 | ///
22 | ///
23 | ///
24 | ///
25 | ///
26 | static public void ApplyEvent(this UndertaleGameObject gameObject, ModFile modFile, params MslEvent[] mslEvents)
27 | {
28 | foreach (MslEvent mslEvent in mslEvents)
29 | {
30 | mslEvent.Apply(gameObject, modFile);
31 | }
32 | }
33 | ///
34 | /// Extension method to apply several to a simultaneously. It is expected that all MslEvent.Code contain their code directly.
35 | /// For example:
36 | ///
37 | /// gameObject.ApplyEvent(
38 | /// new MslEvent(code0, EventType.Create, 0),
39 | /// new MslEvent(code1, EventType.Other, 10),
40 | /// new MslEvent(code2, EventType.Other, 11)
41 | /// );
42 | ///
43 | ///
44 | ///
45 | ///
46 | ///
47 | static public void ApplyEvent(this UndertaleGameObject gameObject, params MslEvent[] mslEvents)
48 | {
49 | foreach (MslEvent mslEvent in mslEvents)
50 | {
51 | mslEvent.Apply(gameObject);
52 | }
53 | }
54 | }
55 | public static partial class Msl
56 | {
57 | ///
58 | /// Add and return a new named to the data.win if this name is not used already.
59 | /// Else return the existing .
60 | /// This methods does not allow any parametrization when creating this .
61 | ///
62 | ///
63 | ///
64 | public static UndertaleGameObject AddObject(string name)
65 | {
66 | return AddObject(
67 | name,
68 | spriteName:"",
69 | parentName: "",
70 | isVisible: false,
71 | isPersistent: false,
72 | isAwake: false,
73 | collisionShapeFlags: CollisionShapeFlags.Circle);
74 | }
75 | ///
76 | /// Add and return a new named to the data.win if this name is not used already.
77 | /// Else return the existing .
78 | /// A lot of parametrization is possible when creating this .
79 | ///
80 | ///
81 | ///
82 | ///
83 | ///
84 | ///
85 | ///
86 | ///
87 | ///
88 | ///
89 | public static UndertaleGameObject AddObject(
90 | string name,
91 | string spriteName = "",
92 | string parentName = "",
93 | bool isVisible = false,
94 | bool isPersistent = false,
95 | bool isAwake = false,
96 | CollisionShapeFlags collisionShapeFlags = CollisionShapeFlags.Circle)
97 | {
98 | try
99 | {
100 | // check if the object exists already
101 | UndertaleGameObject? existingObj = ModLoader.Data.GameObjects.FirstOrDefault(t => t.Name.Content == name);
102 | if(existingObj != null)
103 | {
104 | Log.Information("Cannot create the GameObject since it already exists: {0}", name);
105 | return existingObj;
106 | }
107 |
108 | // retrieve possible parent and sprite
109 | UndertaleSprite? sprite = null;
110 | if (spriteName != "") sprite = GetSprite(spriteName);
111 | UndertaleGameObject? parent = null;
112 | if (parentName != "") parent = GetObject(parentName);
113 |
114 | // doesnt exist so it can be added
115 | UndertaleGameObject obj = new()
116 | {
117 | Name = ModLoader.Data.Strings.MakeString(name),
118 | Sprite = sprite,
119 | ParentId = parent,
120 | Visible = isVisible,
121 | Persistent = isPersistent,
122 | CollisionShape = collisionShapeFlags,
123 | Awake = isAwake,
124 | };
125 | ModLoader.Data.GameObjects.Add(obj);
126 | Log.Information("Successfully created gameObject: {0}", name);
127 | return obj;
128 | }
129 | catch
130 | {
131 | throw;
132 | }
133 | }
134 | ///
135 | /// Return the named if it exists. Else raise an exception.
136 | ///
137 | ///
138 | ///
139 | public static UndertaleGameObject GetObject(string name)
140 | {
141 | UndertaleGameObject gameObject = ModLoader.Data.GameObjects.First(t => t.Name.Content == name);
142 | Log.Information("Found gameObject: {0}", name);
143 | return gameObject;
144 | }
145 | ///
146 | /// Replace the named by .
147 | /// Raise an exception if the named does not exist.
148 | ///
149 | ///
150 | ///
151 | public static void SetObject(string name, UndertaleGameObject o)
152 | {
153 | (int indexObj, _) = ModLoader.Data.GameObjects.Enumerate().First(t => t.Item2.Name.Content == name);
154 | ModLoader.Data.GameObjects[indexObj] = o;
155 | Log.Information("Successfully replaced gameObject: {0}", name);
156 | }
157 | }
158 | }
--------------------------------------------------------------------------------