From 8459bb498c99f7f3dd56b59fd6616b501ff132f4 Mon Sep 17 00:00:00 2001 From: Dragon Taki Date: Thu, 4 Jan 2024 04:40:12 +0800 Subject: [PATCH 1/5] Create README_zht.md --- README_zht.md | 168 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 README_zht.md diff --git a/README_zht.md b/README_zht.md new file mode 100644 index 0000000..d18e5a0 --- /dev/null +++ b/README_zht.md @@ -0,0 +1,168 @@ +# VPet-Simulator + +简体中文(./README.md) | 繁體中文 | [English](./README_en.md) | [日本語](./README_ja.md) + +《虛擬桌寵模擬器》一個開源的桌寵軟體，可以內建至任何WPF應用程式中。 + +![主圖](README.assets/%E4%B8%BB%E5%9B%BE.png) + +在[Steam](https://store.steampowered.com/app/1920960/VPet)上取得虛擬桌寵模擬器（免費），或透過[Nuget](https://www.nuget.org/packages/VPet-Simulator.Core)內建至應用程式中。 + +## 虛擬桌寵模擬器 - 詳細介紹 + +虛擬桌寵模擬器是一款桌寵軟體，支援各種互動，例如投餵等。開源、並支援工作坊。 + +既然都是免費的，那為何不試試呢？ + +本遊戲從[虛擬主播模擬器](https://store.steampowered.com/app/1352140/_/)之桌寵功能獨立出來，如果喜歡，歡迎將[虛擬主播模擬器](https://store.steampowered.com/app/1352140/_/)加入至您的願望清單中。 + +### 超多的互動及動畫 + +多達32（種類）×4（狀態）×3（類型）種動畫。
+*註：部分種類並未有生病或循環等內容，實際上會略低於此數值。* + +#### 動畫範例： + +##### 摸頭 + +![ss0](README.assets/ss0.gif) + +##### 提起 + +![ss4](README.assets/ss4.gif)![ss4](README.assets/ss8.gif) + +##### 爬牆 + +![ss7](README.assets/ss7.gif) + +### 免費 + +本遊戲完全免費！既然都不用錢，那就試試看吧！
+本遊戲主要目的為宣傳[虛擬主播模擬器](https://store.steampowered.com/app/1352140/_/)中的Q版人物主角。 + +### 開源 + +本遊戲於Github上開源，歡迎提出自己的想法、創意，或直接參與開發！
+您還可以修改原始碼來製作自己專屬的桌寵！（雖然說大部分內容支援工作坊，毋須修改程式碼）
+專案位置：https://github.com/LorisYounger/VPet + +### 支援工作坊 + +本遊戲支援工作坊，您可以自行製作桌寵角色、動畫或互動內容，並上傳至工作坊中分享給更多人使用。 + +模組製作器：https://github.com/LorisYounger/VPet.ModMaker + +工作坊支援加入／修改下列內容 + +* 桌寵動畫 +* 物品／食品／飲料等 +* 自訂桌寵工作內容 +* 對話內容 +* 主題 +* 代碼插件：編撰程式碼來加入新內容 + * 加入新的動畫邏輯或顯示效果（例如：l2d/spine等） + * 加入新功能（鬧鐘、記事本等） + * 幾乎無所不能，範例請見[VPet.Plugin.Demo](https://github.com/LorisYounger/VPet.Plugin.Demo) + +###聯絡我們 + +若有建議或意見，可以在Steam商店、Steam社群中評論，在Github發Issue，使用虛擬桌寵模擬器QQ群（907101442）或電子郵件[mailto:service@exlb.net](mailto:service@exlb.net)聯絡作者。 + +## 程式架構 + +* **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 工作时钟 + +## 参与开发 + +欢迎参与虚拟桌宠模拟器的开发! 为保证代码可维护度和游戏性,如果想要开发新的功能,请先[邮件联系](mailto:zoujin.dev@exlb.org)或发[Issues](https://github.com/LorisYounger/VPet/issues)我想要添加的功能/玩法, 以确保该功能/玩法适用于虚拟桌宠模拟器. 以免未来提交时因不合适被拒(而造成代码浪费)
+如果是修复错误或者BUG,无需联系我,修好后直接PR即可 + +当想法通过后,您可以通过 [fork](https://github.com/LorisYounger/VPet/fork) 功能拷贝代码至自己的github以方便编写自己的代码, 编写完毕后通过[pull requests](https://github.com/LorisYounger/VPet/compare) 提交
+如果您想法没有被通过,也可以另起炉灶,写个不同版本功能的桌宠软件. 但需遵守 [Apache License 2.0](https://github.com/LorisYounger/VPet/blob/main/LICENSE) 与 [动画版权声明与授权](https://github.com/LorisYounger/VPet#%E5%8A%A8%E7%94%BB%E7%89%88%E6%9D%83%E5%A3%B0%E6%98%8E%E4%B8%8E%E6%8E%88%E6%9D%83) +注: 一般来讲, 添加新功能都可以通过编写代码插件MOD实现, 详情请参见 [VPet.Plugin.Demo](https://github.com/LorisYounger/VPet.Plugin.Demo) + +我可能会对您的提交的代码进行修改,删减等以确保该功能/玩法适用于虚拟桌宠模拟器. + + +感谢以下参与的开发和翻译人员 + + + + + +和提供社区翻译和更多内容的创意工坊人员 + +## 动画版权声明与授权 + +在github中 [桌宠动画文件](https://github.com/LorisYounger/VPet/tree/main/VPet-Simulator.Windows/mod/0000_core/pet/vup) 动画版权归 [虚拟主播模拟器制作组](https://www.exlb.net/VUP-Simulator)所有, 当使用本类库时,您可能需要自行准备动画文件,或遵循以下协议 + +> **注 ** +> 本动画声明仅限于桌宠自带的动画, 若有画师/开发者画自己的动画适配给桌宠,并不遵循用本声明 + +### 非商用用途授权 + +* 需要向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 +* 当您完成以上要求后,您可以免费使用动画文件 + +### 商用用途授权 + +* 第一次使用时需弹窗并醒目的向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 +* 在相应页面(用户可以快捷访问)向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 + +* 禁止通过出售动画文件进行盈利 +* 请[邮件联系](mailto:zoujin.dev@exlb.org)我 +* 当您完成以上要求后,您可以免费使用动画文件 + +### 分发动画文件 + +* 需要告知以上所有授权信息 +* 需要提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 +* 分发动画文件时禁止任何付费/收费行为 + +## 桌面端部署方法 + +1. 下载本项目, 通过VisualStudio打开 `VPet.sln` 文件 +2. 在生成栏中, 选择 位数为 `x64` 和生成项目为 `Vpet-Simulator.Windows` + ![image-20230208004330895](README.assets/image-20230208004330895.png) +3. 点击启动, 如果一切正常则会报错 `缺少模组Core,无法启动桌宠` +4. 以管理员身份运行 `mklink.bat`, 这会让mod文件链接到生成位置 +5. 再次点击启动即可正常运行 From 46a3cb920aeae8df2af0c3d5eab65efa871855b3 Mon Sep 17 00:00:00 2001 From: Dragon Taki Date: Thu, 4 Jan 2024 05:08:15 +0800 Subject: [PATCH 2/5] Update README_zht.md --- README_zht.md | 155 +++++++++++++++++++++++++------------------------- 1 file changed, 77 insertions(+), 78 deletions(-) diff --git a/README_zht.md b/README_zht.md index d18e5a0..dc465a0 100644 --- a/README_zht.md +++ b/README_zht.md @@ -68,101 +68,100 @@ 若有建議或意見，可以在Steam商店、Steam社群中評論，在Github發Issue，使用虛擬桌寵模擬器QQ群（907101442）或電子郵件[mailto:service@exlb.net](mailto:service@exlb.net)聯絡作者。 -## 程式架構 -* **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 窗体控制器 (调用相关功能和设置,例如移动到侧边等) +## 軟體架構 + +* **VPet-Simulator.Windows: 適用於桌面端的虛擬桌寵模擬器** + * *Function 功能性程式碼儲存位置* + * CoreMOD 模組管理 + * MWController 視窗控制器 + + * *WinDesign 視窗及UI設計 + * winBetterBuy 更好買視窗 + * winCGPTSetting ChatGPT設定 + * winSetting 軟體設定、模組視窗 + * winConsole 開發控制台 + * winGameSetting 遊戲設定 + * winReport 意見回饋中心 + + * MainWindows 主視窗、儲存及展示Core + * PetHelper 快速切換圖示 +* **VPet-Simulator.Tool: 方便製作模組的工具（例如：產生動態圖片）** +* **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 工作时钟 - -## 参与开发 - -欢迎参与虚拟桌宠模拟器的开发! 为保证代码可维护度和游戏性,如果想要开发新的功能,请先[邮件联系](mailto:zoujin.dev@exlb.org)或发[Issues](https://github.com/LorisYounger/VPet/issues)我想要添加的功能/玩法, 以确保该功能/玩法适用于虚拟桌宠模拟器. 以免未来提交时因不合适被拒(而造成代码浪费)
-如果是修复错误或者BUG,无需联系我,修好后直接PR即可 - -当想法通过后,您可以通过 [fork](https://github.com/LorisYounger/VPet/fork) 功能拷贝代码至自己的github以方便编写自己的代码, 编写完毕后通过[pull requests](https://github.com/LorisYounger/VPet/compare) 提交
-如果您想法没有被通过,也可以另起炉灶,写个不同版本功能的桌宠软件. 但需遵守 [Apache License 2.0](https://github.com/LorisYounger/VPet/blob/main/LICENSE) 与 [动画版权声明与授权](https://github.com/LorisYounger/VPet#%E5%8A%A8%E7%94%BB%E7%89%88%E6%9D%83%E5%A3%B0%E6%98%8E%E4%B8%8E%E6%8E%88%E6%9D%83) -注: 一般来讲, 添加新功能都可以通过编写代码插件MOD实现, 详情请参见 [VPet.Plugin.Demo](https://github.com/LorisYounger/VPet.Plugin.Demo) - -我可能会对您的提交的代码进行修改,删减等以确保该功能/玩法适用于虚拟桌宠模拟器. + * GameCore 遊戲核心，包含各種資料數據等內容 + * GameSave 遊戲存檔 + * IFood 食物及物品介面 + * PetLoader 寵物圖片載入器 + * Graph 圖形渲染 + * IGraph 動畫基本介面 + * GraphCore 動畫顯示核心 + * GraphHelper 動畫幫助 + * GraphInfo 動畫資訊 + * FoodAnimation 食物動畫，支援顯示前中後三層夾心動畫，不一定只用於食物，只是叫這個名字 + * PNGAnimation 桌寵動態動畫元件 + * Picture 桌寵靜態動畫元件 + * Display 顯示 + * basestyle/Theme 基礎風格主題 + * Main.xaml 核心顯示元件 + * MainDisplay 核心顯示方法 + * MainLogic 核心顯示邏輯 + * ToolBar 點擊人物時的工具欄 + * MessageBar 人物說話時的對話框 + * WorkTimer 運作計時器 -感谢以下参与的开发和翻译人员 +## 參與開發 + +歡迎參與虛擬桌寵模擬器的開發！為了保證程式碼的可維護性及遊戲性，若想要開發新的功能，請先[電子郵件聯絡](mailto:zoujin.dev@exlb.org)或提交[Issue](https://github.com/LorisYounger/VPet/issues)，標題為想要新增的功能／玩法，以確保該功能／玩法適用於虛擬桌寵模擬器，以免在您完成開發後，因不適合而被拒絕（而浪費您的時間）。
+如果是修正錯誤或BUG，則不需要先行聯絡，修好後直接提交即可。 + +當您提供的想法被贊同後，您可以使用[Fork](https://github.com/LorisYounger/VPet/fork)功能，將專案程式碼整個複製至個人的Github上，以便撰寫自己的程式碼。撰寫完畢後，使用[Pull Requests](https://github.com/LorisYounger/VPet/compare)提交。
+若您的想法並未被同意，也可以另起爐灶，開發一個不同版本及功能的桌寵軟體。須遵守[Apache License 2.0](https://github.com/LorisYounger/VPet/blob/main/LICENSE)及[動畫版權聲明與授權](https://github.com/LorisYounger/VPet/blob/main/README_zht.md#%E5%8B%95%E7%95%AB%E7%89%88%E6%AC%8A%E8%81%B2%E6%98%8E%E8%88%87%E6%8E%88%E6%AC%8A)。
+註：一般而言，加入新功能都可以透過撰寫模組來達成，詳情請見：[VPet.Plugin.Demo](https://github.com/LorisYounger/VPet.Plugin.Demo) + +作者可能會修改、刪減部分您所提交的程式碼，以確保該功能／玩法適用於虛擬桌寵模擬器。 + + +感謝下列參與的開發及翻譯人員 -和提供社区翻译和更多内容的创意工坊人员 +以及提供社群翻譯與更多內容的工作坊作者 -## 动画版权声明与授权 +## 動畫版權聲明與授權 -在github中 [桌宠动画文件](https://github.com/LorisYounger/VPet/tree/main/VPet-Simulator.Windows/mod/0000_core/pet/vup) 动画版权归 [虚拟主播模拟器制作组](https://www.exlb.net/VUP-Simulator)所有, 当使用本类库时,您可能需要自行准备动画文件,或遵循以下协议 +在Github中，[桌寵動畫檔案](https://github.com/LorisYounger/VPet/tree/main/VPet-Simulator.Windows/mod/0000_core/pet/vup)之動畫版權歸[虛擬主播模擬器製作組](https://www.exlb.net/VUP-Simulator)所有，在使用本類別庫時，您可能會需要自行準備動畫檔，或遵循下列協定：
+*註：本聲明只限於桌寵自帶的動畫，其餘經工作坊等方式額外加入的內容並不適用* -> **注 ** -> 本动画声明仅限于桌宠自带的动画, 若有画师/开发者画自己的动画适配给桌宠,并不遵循用本声明 +### 非商業用途授權 -### 非商用用途授权 +* 需要向使用者告知動畫檔案的來源，並提供造訪[本頁面](https://github.com/LorisYounger/VPet)的連結 +* 當您完成上述要求後，可以免費使用動畫檔案 -* 需要向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 -* 当您完成以上要求后,您可以免费使用动画文件 +### 商業用途授權（低於10萬） -### 商用用途授权 +* 在使用者第一次使用時，需跳出視窗，並醒目向使用者告知動畫檔案的來源，並提供造訪[本頁面](https://github.com/LorisYounger/VPet)的連結 +* 在對應的頁面上（使用者能快速造訪的），向使用者告知動畫檔案的來源，並提供造訪[本頁面](https://github.com/LorisYounger/VPet)的連結 +* 不得透過出售動畫檔案營利 +* 請[電子郵件聯絡](mailto:zoujin.dev@exlb.org)本軟體作者 +* 當您完成上述要求後，可以免費使用動畫檔案 -* 第一次使用时需弹窗并醒目的向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 -* 在相应页面(用户可以快捷访问)向用户告知动画文件来源并提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 +### 轉發動畫檔案 -* 禁止通过出售动画文件进行盈利 -* 请[邮件联系](mailto:zoujin.dev@exlb.org)我 -* 当您完成以上要求后,您可以免费使用动画文件 +* 需要告知上述所有授權資訊 +* 需要提供造訪[本頁面](https://github.com/LorisYounger/VPet)的連結 +* 轉發動畫檔案時，禁止任何付費或收費行為 -### 分发动画文件 +## 桌面應用程式部署方式 -* 需要告知以上所有授权信息 -* 需要提供访问 [该页面](https://github.com/LorisYounger/VPet) 的链接 -* 分发动画文件时禁止任何付费/收费行为 - -## 桌面端部署方法 - -1. 下载本项目, 通过VisualStudio打开 `VPet.sln` 文件 -2. 在生成栏中, 选择 位数为 `x64` 和生成项目为 `Vpet-Simulator.Windows` +1. 下載本專案，透過VisualStudio開啟`VPet.sln`檔案 +2. 在「建置」選項中，選擇位元數`x64`及建置專案`Vpet-Simulator.Windows` ![image-20230208004330895](README.assets/image-20230208004330895.png) -3. 点击启动, 如果一切正常则会报错 `缺少模组Core,无法启动桌宠` -4. 以管理员身份运行 `mklink.bat`, 这会让mod文件链接到生成位置 -5. 再次点击启动即可正常运行 +3. 點擊「開始」，若一切順利將會報錯`缺少Core模組，無法啟動桌寵` +4. 以管理員身分執行`mklink.bat`，這會讓模組檔案連結至產生的位置 +5. 再次點擊啟動即可正常執行 From f4e2d539522f05f05bd3925eb84fb1c299c5c8f3 Mon Sep 17 00:00:00 2001 From: Dragon Taki Date: Thu, 4 Jan 2024 05:17:28 +0800 Subject: [PATCH 3/5] Add zht README by DragonTaki --- README_ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_ja.md b/README_ja.md index 957fe3e..4e7fa1a 100644 --- a/README_ja.md +++ b/README_ja.md @@ -1,6 +1,6 @@ # VPet -[简体中文](./README.md) | [English](./README_en.md) | 日本語 +[简体中文](./README.md) | [繁體中文](./README_zht.md) | [English](./README_en.md) | 日本語 ![Header](README.assets/%E4%B8%BB%E5%9B%BE.png) From d73674d2330e6f731512cc7d405cc86d793e333b Mon Sep 17 00:00:00 2001 From: Dragon Taki Date: Thu, 4 Jan 2024 05:17:46 +0800 Subject: [PATCH 4/5] Add zht README by DragonTaki --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index f65078f..dcd0f95 100644 --- a/README_en.md +++ b/README_en.md @@ -1,6 +1,6 @@ # VPet -[简体中文](./README.md) | English | [日本語](./README_ja.md) +[简体中文](./README.md) | [繁體中文](./README_zht.md) | English | [日本語](./README_ja.md) ![Header](README.assets/%E4%B8%BB%E5%9B%BE.png) From cdf1cbd616c020eb8d515afd655641f3a0089e8f Mon Sep 17 00:00:00 2001 From: Dragon Taki Date: Thu, 4 Jan 2024 05:17:59 +0800 Subject: [PATCH 5/5] Add zht README by DragonTaki --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b5583ca..e10ba54 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # VPet-Simulator -简体中文 | [English](./README_en.md) | [日本語](./README_ja.md) +简体中文 | [繁體中文](./README_zht.md) | [English](./README_en.md) | [日本語](./README_ja.md) 虚拟桌宠模拟器 一个开源的桌宠软件, 可以内置到任何WPF应用程序 @@ -165,4 +165,4 @@ MOD制作器: https://github.com/LorisYounger/VPet.ModMaker ![image-20230208004330895](README.assets/image-20230208004330895.png) 3. 点击启动, 如果一切正常则会报错 `缺少模组Core,无法启动桌宠` 4. 以管理员身份运行 `mklink.bat`, 这会让mod文件链接到生成位置 -5. 再次点击启动即可正常运行 \ No newline at end of file +5. 再次点击启动即可正常运行