VPet/CONTRIBUTING.md
2023-12-14 04:31:51 +08:00

4.6 KiB

简体中文 | 繁體中文 | English

参与开发

欢迎参与虚拟桌宠模拟器的开发! 为保证代码可维护度和游戏性,如果想要开发新的功能,请先邮件联系或发Issues我想要添加的功能/玩法, 以确保该功能/玩法适用于虚拟桌宠模拟器. 以免未来提交时因不合适被拒(而造成代码浪费)
如果是修复错误或者BUG,无需联系我,修好后直接PR即可

当想法通过后,您可以通过 fork 功能拷贝代码至自己的github以方便编写自己的代码, 编写完毕后通过pull requests 提交
如果您想法没有被通过,也可以另起炉灶,写个不同版本功能的桌宠软件. 但需遵守 Apache License 2.0动画版权声明与授权 注: 一般来讲, 添加新功能都可以通过编写代码插件MOD实现, 详情请参见 VPet.Plugin.Demo

我可能会对您的提交的代码进行修改,删减等以确保该功能/玩法适用于虚拟桌宠模拟器.

动画版权声明与授权

在github中 桌宠动画文件 动画版权归 虚拟主播模拟器制作组所有, 当使用本类库时,您可能需要自行准备动画文件,或遵循以下协议

非商用用途授权

  • 需要向用户告知动画文件来源并提供访问 该页面 的链接
  • 当您完成以上要求后,您可以免费使用动画文件

商用用途授权(低于10万)

  • 第一次使用时需弹窗并醒目的向用户告知动画文件来源并提供访问 该页面 的链接
  • 在相应页面(用户可以快捷访问)向用户告知动画文件来源并提供访问 该页面 的链接
  • 当您完成以上要求后,您可以免费使用动画文件

商用用途授权(高于10万或其他)

分发动画文件

  • 需要告知以上所有授权信息
  • 需要提供访问 该页面 的链接
  • 分发动画文件时禁止任何付费/收费行为

桌面端部署方法

  1. 下载本项目, 通过VisualStudio打开 VPet.sln 文件
  2. 在生成栏中, 选择 位数为 x64 和生成项目为 Vpet-Simulator.Windows image-20230208004330895
  3. 点击启动, 如果一切正常则会报错 缺少模组Core,无法启动桌宠
  4. 以管理员身份运行 mklink.bat, 这会让mod文件链接到生成位置
  5. 再次点击启动即可正常运行

软件结构

  • VPet-Simulator.Windows: 适用于桌面端的虚拟桌宠模拟器
    • Function 功能性代码存放位置

      • CoreMOD Mod管理类
      • MWController 窗体控制器
    • *WinDesign 窗口和UI设计

      • winBetterBuy 更好买窗口
      • winCGPTSetting ChatGPT 设置
      • winSetting 软件设置/MOD 窗口
      • winConsole 开发控制台
      • winGameSetting 游戏设置
      • winReport 反馈中心
    • MainWindows 主窗体,存放和展示Core

    • PetHelper 快速切换小标

  • VPet-Simulator.Tool: 方便制作MOD的工具(eg:图片帧生成)
  • VPet-Simulator.Core: 软件核心 方便内置到任何WPF应用程序(例如:VUP-Simulator)
    • Handle 接口与控件
      • IController 窗体控制器 (调用相关功能和设置,例如移动到侧边等)
      • Function 通用功能
      • GameCore 游戏核心,包含各种数据等内容
      • GameSave 游戏存档
      • IFood 食物/物品接口
      • PetLoader 宠物图形加载器
    • Graph 图形渲染
      • IGraph 动画基本接口
      • GraphCore 动画显示核心
      • GraphHelper 动画帮助类
      • GraphInfo 动画信息
      • FoodAnimation 食物动画 支持显示前中后3层夹心动画 不一定只用于食物,只是叫这个名字
      • PNGAnimation 桌宠动态动画组件
      • Picture 桌宠静态动画组件
    • Display 显示
      • basestyle/Theme 基本风格主题
      • Main.xaml 核心显示部件
        • MainDisplay 核心显示方法
        • MainLogic 核心显示逻辑
      • ToolBar 点击人物时候的工具栏
      • MessageBar 人物说话时候的说话栏
      • WorkTimer 工作时钟