CustomMenu

一个为《杀戮尖塔2》设计的主菜单定制模组。

A  mod for Slay the Spire 2 that allows you to fully customize your main menu.

本模组需同时安装 `ModConfig` 模组以获得图形化设置界面，它是前置。

This mod uses `ModConfig` as an requirement for graphical configuration.

主要特性 | Features

自定义背景 | Custom Background：支持 PNG / JPG  格式，轻松换上你喜欢的壁纸。

自定义音乐 | Custom Music：支持 OGG  格式，让每次打开游戏都伴随你最爱的旋律。

图形化配置界面 | GUI Configuration：基于 (https://www.nexusmods.com/slaythespire2/mods/27) 框架，在游戏内“设置 -> 模组”中即可轻松调整。

一键访问资源目录 | One-click Access：提供“打开 user:// 文件夹”按钮，方便你放置文件。

智能路径处理 | Smart Path Handling：支持 `user://` 短路径和绝对路径，并自动处理反斜杠等常见问题。

兼容 | Perfect Compatibility：游戏更新时无需额外适配，也通常与绝大多数模组兼容。

安装方法 | Installation

1.  手动安装：将 `CustomMenu` 文件夹放入 `[游戏根目录]/mods/` 文件夹中。

2.  确保 Mod 文件夹结构正确：最终路径应为 `.../mods/CustomMenu/CustomMenu.dll`。

3.  安装 ModConfig (可选但强烈推荐)：访问 (https://www.nexusmods.com/slaythespire2/mods/27) 下载并放入 `mods` 文件夹。

1. Manual Installation: Place the CustomMenu folder inside the /mods/ folder.

2. Ensure the Mod Folder Structure Is Correct: The final path should be .../mods/CustomMenu/CustomMenu.dll.

3. Install ModConfig (Optional but Strongly Recommended): Visit the ModConfig page, download it, and put it into the mods folder.

如何使用 | How to Use

推荐使用 `user://` 短路径：打开 `开始 -> 运行 -> %AppData%\SlayTheSpire2`，把你准备好的背景图片和音乐文件放进去。

启动游戏：点击 `设置 -> 模组 -> Custom Menu`，勾选“启用自定义背景/音乐”，并在路径框中输入文件名（例如 `user://bg.png`）。

重启游戏：所有配置需重启游戏后生效。

Recommended: Use the user:// short path: Open Start -> Run -> %AppData%\SlayTheSpire2 and place your prepared background images and music files there.

Launch the game: Go to Settings -> Mods -> Custom Menu, check "Enable Custom Background/Music", and enter the file name in the path box (e.g., user://bg.png).

Restart the game: All settings take effect after restarting the game.

注意事项 | Notes

路径格式：强烈建议使用 `user://` 短路径。如果使用绝对路径，请使用正斜杠 `/`，例如 `D:/my_images/poster.png`。(如果路径文本长度超出限制会失效）

图片尺寸：图片分辨率不限，模组会自动缩放以完整显示（可能会有黑边）。如需完全无黑边，可选择“铺满”模式（后续版本）。

音频格式：测试支持的格式为 OGG。

Path Format: It is strongly recommended to use the user:// short path. If you need to use an absolute path, please use forward slashes /, e.g., D:/my_images/poster.png.(Note: Path strings that are too long may cause this feature to fail.)

Image Size: Images of any resolution are supported. The mod will automatically scale the image to fit the screen (black bars may appear). To completely eliminate black bars, choose the "Fill" mode (coming in a future version).

Audio Format: The tested and supported format is OGG.

已知问题 | Known Issues

如果您发现了任何问题，欢迎在评论区留言反馈！

If you encounter