Yayin Story Studio 文档首页
欢迎使用 Yayin Story Studio 的官方文档!本页面提供了 Yayin Story Studio 的各个模块和功能的详细介绍,
这份官方文档更多的是面向开发者的,如果您是普通用户,建议参考 Yayin Story Studio 用户文档 - 语雀 。
如果您需要ASE-Remake教程,请另行参阅 ASER 官方文档 - 语雀 。
模块介绍
Yayin Story Studio 由多个模块(子项目)构成
- Visindigo 模块:核心中的核心,提供最最基础的Qt封装和扩展功能。根命名空间即为 Visindigo 。
- Yayin Story Studio Core 模块:Yayin Story Studio 的核心模块,提供了Yayin Story Studio本体的基础功能。根命名空间为 YSSCore 。
- Yayin Story Studio 模块:Yayin Story Studio 本体模块,YSS的GUI实现大多在此,根命名空间为YSS 。 Yayin Story Studio 没有太多文档,因为它基本上不作为开放API供外部使用。
- Plugin_ASERStudio 模块:ASE Studio 插件模块,提供了 ASE Studio 插件的实现。根命名空间为 ASERStudio 。
开发Visindigo/YSS插件
要开发Visindigo插件,可以参见类Visindigo::General::Plugin的文档。这部分包含该类使用与使插件生效的基本教程
至于开发YSS插件,则请参考页面YSSPluginDev 和类YSSCore::Editor::EditorPlugin的文档。
由于开发YSS插件目前主要是涉及对YSS的语言支持进行扩展,而语言支持又相当复杂,因此详细文档是单列的,并未合并在类的说明文档中。
附带实用工具
Yayin Story Studio 项目附带了一些用于辅助开发和测试的Python工具,参见 项目附带的Python工具 文档。
贡献代码
Yayin Story Studio 在Github上开源,参见 Yayin Story Studio Github 仓库 。
不过目前YSS还没有准备好接受外部贡献(无论是考虑到目前暂时没有为此准备的工作流程,还是考虑到代码质量和项目稳定性), 因此如果您有兴趣为YSS贡献代码,请先联系开发者。
许可证
Yayin Story Studio中的每一个子项目均采用“一版一许可”的方式进行许可。在Github Release页面中, 每次发布新版本时,请自行留意对应source code中采用的许可证类型。许可证只对当前版本有效,未来版本可能会更改许可证类型。