GalMC API

中文ZH_CN

Ciallo ~ (∠ · ω< )︵☆ 想在 Minecraft 里面玩 GalGame？来一场痛快的纸片人恋爱？ GalMC API，也许能帮你圆梦。

简介：

GalMC API 提供了一个运行于 Minecraft 内部的 Galgame 用户界面引擎。本模组本身不包含任何剧情内容，而是作为一个功能框架：你只需将制作好的资源包放入指定路径，即可通过游戏内指令（未来将升级为自定义事件驱动的自动触发）打开并游玩一个 Galgame。

使用：

本项目有一个附属的Python项目，提供了快速方便制作此模组要求的资源包的UI界面，只需要准备好背景、文本、立绘、语音和音乐还有CG，就可以在那个UI的编辑器快速编辑，书写你的GalGame剧情。

玩家只需要把打包好的资源包放入到config/galmc_api/resourcepacks文件夹下（初次启动没有此文件夹等待第二次启动），在启动游戏后在资源包页面可以找到导入的资源包，启用此资源包就可以在游戏里面使用指令/play_galgame 资源路径（提供列表）打开GalGame的页面。

对于开发者而言，可以通过此指令打开GalGame辅助地图和整合包制作……例如在关键节点插入视觉小说式演出，替代传统的告示牌或书本叙事使得更加有沉浸感；制作带立绘和配音的剧情指引，告别生硬的文字说明

甚至可以真的将GalGame的恋爱元素制作进入Minecraft，夸张一点说可以把它和可爱的方块妹子相结合，利用此Mod展现各种GalGame的剧情，在Minecraft里面观赏精致的 CG 插图，让玩家在沙盒世界中也能体验到来自于二次元GalGame的情感陪伴。（希望能有个厉害的开发者能用此模组更方便地将这种情感陪伴整合包做出来，目前Minecraft还没见到有专门像GalGame恋爱模拟冒险的整合包）

并且此Mod高度自定义，如果编辑器内的的功能不能满足，可以直接在此Mod的基础上修改和添加你的代码并打包，修改后的Mod可以连同资源包一起分发

注意事项

1，此Mod为测试版，会有很多预料之外的BUG，轻则功能不能正常使用，重则崩溃，感谢各位玩家将Bug上传到Github的Issue 2，由于作者（初三）学业繁忙时间紧凑，故25%的Java代码和90%Python代码由AI生成甚至这个页面也使用了AI，代码质量也不是很高，相关的开发文档和使用说明可能更新较慢，敬请谅解。 3，此Mod功能不是很完整，目前还有设置页面、BackLog（历史）页面、存读档、简单的高级立绘渲染未完成，预计将会制作详细的制作手册和代码编辑Wiki，功能上未来将会制作使用UI界面制作自动检测触发剧情、自定义剧情进度管理系统、在UI自定义视频渲染和高级CG渲染 4，我不是柚子厨，也不是专业的 Galgame 玩家，只是觉得这个想法很有趣，所以尝试做出来。如有不足之处，还请多多包涵，不喜勿喷 🙏

---

EN_US English（Used DeepSeek AI to Translate）

Ciallo ~ (∠ · ω< )︵☆
Want to play GalGames in Minecraft? Experience a heartfelt 2D romance?
GalMC API might just help make your dream come true.

Introduction:

GalMC API provides a Galgame user interface engine that runs inside Minecraft. This mod itself does not contain any storyline content; instead, it serves as a functional framework: you simply place your custom-made resource pack into the specified directory, and you can start and play a Galgame using in-game commands (which will be upgraded to custom event-driven automatic triggers in the future).

Usage:

This project includes an accompanying Python project, which provides a user interface for quickly and conveniently creating resource packs required by this mod. You only need to prepare backgrounds, text, character sprites, voice lines, music, and CGs, then use the UI editor to quickly write and assemble your Galgame storyline.

Players simply place the packaged resource pack into the config/galmc_api/resourcepacks folder (this folder will be created after the second launch if it doesn't exist initially). After launching the game, you can find the imported resource pack in the resource packs page. Enable it, and then use the in-game command /play_galgame <resource_path> (with a provided list) to open the Galgame interface.

For developers, this command can be used to assist in creating Galgame-style adventure maps and modpacks—for example, inserting visual novel-style performances at key moments to replace traditional signboards or book-based storytelling, making the experience more immersive. You can create guided storylines with character sprites and voice acting, moving away from stiff textual explanations.

You could even incorporate romantic elements from GalGames into Minecraft. To put it grandly, you could combine it with cute block-styled characters, use this mod to present various Galgame storylines, and enjoy exquisite CG illustrations within Minecraft—allowing players to experience the emotional companionship of 2D GalGames within a sandbox world. (Hopefully, a talented developer can use this mod to more conveniently create such emotionally immersive modpacks, as there currently aren't any Minecraft modpacks specifically focused on Galgame-style romance simulation adventures.)

Moreover, this mod is highly customizable. If the editor's features are insufficient, you can directly modify and add your own code based on this mod and repackage it. The modified mod can then be distributed along with your resource pack.

Notes

1. This mod is a beta version and may contain many unexpected bugs, ranging from minor feature malfunctions to game crashes. We appreciate players reporting bugs via Github Issues.
2. Due to the author's busy academic schedule (9th grade), 25% of the Java code and 90% of the Python code were generated by AIand even this page was written with AI assistance. The code quality may not be very high, and related development documentation and usage instructions may be updated slowly. Your understanding is appreciated.
3. The mod's features are not yet complete. Currently unfinished features include the settings page, BackLog (history) page, save/load functionality, and simple advanced character sprite rendering. A detailed production manual and code editing Wiki are planned. Future features will include UI-based automatic event detection for triggering storylines, custom storyline progress management systems, and UI-based custom video rendering and advanced CG rendering.
4. I'm not a YuzuSoft fan, nor a professional Galgame developer—I just found this idea interesting and decided to try making it. If there are any shortcomings, please bear with me. If you don't like it, that's okay, but please refrain from harsh criticism 🙏

作者Bilibili:https://space.bilibili.com/1502398028