README

Author: c0re100

README.md

@@ -0,0 +1,55 @@
+# IMYSHook
+
+## [中文](README_TC.md)
+
+Iris Mysteria mod for DMM Game Player version
+
+## Feature
+
+1. Game speed
+2. In-game Screenshot
+3. FPS setting
+4. [Translation](Translation.md) (Traditional Chinese only)
+
+## Requirement
+
+1. Windows 10 or newer
+2. Iris Mysteria DMM Game Player version
+
+## Installation
+
+Download and extract [Release](https://github.com/IrisMystery/IMYSHook/releases) zip to your Iris Mysteria install
+location `C:\Users\<username>\imys_r_exe`
+
+## Config
+
+You can edit config.json(`./BepInEx/plugins/config.json`) if you don't like default settings.
+
+| Name      | Default Value | Description                                                  |
+|-----------|---------------|--------------------------------------------------------------|
+| speed     | 0.5           | Increase/Decrease game speed each step (per click)           | 
+| fps       | 60            | Override FPS setting, take effects when value bigger than 60 |
+| translate | true          | Enable/Disable translation feature                           |
+
+## Key binding
+
+| Key | Type        | Description                                                                   |
+|-----|-------------|-------------------------------------------------------------------------------|
+| F5  | Freeze      | Freeze game, mean set game speed to 0x                                        |
+| F6  | Reset       | Reset game speed to 1x/normal                                                 | 
+| F7  | Decrease    | Decrease game speed (2-0.5 etc), depends on your `speed` config               | 
+| F8  | Increase    | Increase game speed (1+0.5 etc), depends on your `speed` config               |
+| F11 | Translation | Clear translation cache                                                       |
+| F11 | Translation | Enable/Disable translation feature                                            |
+| F12 | Screenshot  | Screenshot current frame and save to Pictures(`C:\Users\<username>\Pictures`) |
+
+## Contributing
+
+You're free to contribute to IMYSHook as long as the features are useful, such as battle stats log, 360 stamina alert or
+something else, except modifying battle data.
+
+## Disclaimer
+
+Using IMYSHook violates Iris Mysteria and DMM's terms of service.
+
+I will NOT be held responsible for any bans!

README_TC.md

@@ -0,0 +1,54 @@
+# IMYSHook
+
+## [English](README.md)
+
+愛秘mod (DMM Game Player版)
+
+## 功能
+
+1. 更改遊戲速度
+2. 內置遊戲截圖
+3. FPS設定
+4. [中文翻譯](Translation.md)
+
+## 需求
+
+1. Windows 10或以上
+2. 愛秘 DMM Game Player版本
+
+## 安裝方法
+
+下載[Release](https://github.com/IrisMystery/IMYSHook/releases)
+並解壓縮至您的愛秘安裝位置 `C:\Users\<username>\imys_r_exe`
+
+## 設定
+
+如果您不喜歡預設設定，可以編輯config.json(`./BepInEx/plugins/config.json`).
+
+| 欄位        | 預設值  | 說明                         |
+|-----------|------|----------------------------|
+| speed     | 0.5  | 加快/減慢遊戲速度 (每按一下)           | 
+| fps       | 60   | 更改FPS值, 只會在遊戲開啟60FPS的情況下生效 |
+| translate | true | 閣啟/關閉中文翻譯功能                |
+
+## 綁定鍵
+
+| 按鍵   | 類型 | 說明                                       |
+|------|----|------------------------------------------|
+| F5   | 靜止 | 將遊戲暫時凍結                                  |
+| F6   | 重設 | 將遊戲重設至正常速度                               | 
+| F7   | 減少 | 減慢遊戲速度，視乎您的 `speed` 設定                   | 
+| F8   | 增加 | 加快遊戲速度，視乎您的 `speed` 設定                   |
+| F10  | 翻譯 | 刪除翻譯快取                                   |
+| F11  | 翻譯 | 開啟/關閉中文翻譯功能                              |
+| F12  | 截圖 | 截取當前的遊戲畫面至`C:\Users\<username>\Pictures` |
+
+## 貢獻
+
+您可以PR一些有用的功能，例如戰鬥紀錄、滿體提示之類，除了修改戰鬥數值
+
+## 免責聲明
+
+使用修改程式進行遊戲，均屬違規行為，可能導致帳號被封鎖。
+
+本人概不負責。

Translation.md

@@ -0,0 +1,61 @@
+## 禁止利用相關資源作為商業用途
+
+## 禁止利用相關資源作為商業用途
+
+## 禁止利用相關資源作為商業用途
+
+## 很重要所以說三次
+
+### 翻譯狀況
+
+首先，19章前將會沿用中文版的翻譯，而20章後將採用機器翻譯+人工校對方式
+
+因後續翻譯皆由機器翻譯所得，所以不喜歡可以上一頁 :)
+
+但同時，也是由愛好者共同維護的翻譯
+
+目前使用的翻譯模型: [SakuraLLM](https://github.com/SakuraLLM/Sakura-13B-Galgame)
+
+**已知問題:** 
+
+暫無
+
+### 翻譯修正
+
+部分文本已經在發佈前進行過一次人手修正
+
+但因為目前全劇情字數高達[500萬字](https://translation.lolida.best/projects/imys/#information)
+
+在單人維護的情況下，實在無能為力。
+
+如果您有日文能力的話，可以為這份翻譯貢獻一己之力
+
+任何人都可以到我們的[協作翻譯平台](https://translation.lolida.best/projects/imys/)查看及修正，感激不盡！
+
+### 翻譯修改教學
+
+問: 我找到某處翻譯有錯，要怎麼修正?
+
+答: 假設，你在看第20章第1話劇情發現其中一句有問題
+
+![imys_translation1.png](./img/imys_translation1.png)
+
+這時候可以切換至控制台，你會看到一個main_20001_1的文字
+
+這個就是劇情ID
+
+![imys_translation2.png](./img/imys_translation2.png)
+
+你可以在翻譯平台搜尋這個ID，也可以複製下列網址並修改劇情ID為main_20001_1即可進入相關的翻譯文本位置
+
+`https://translation.lolida.best/browse/imys/劇情ID/zh_Hant/`
+
+點擊相關句子後會進修改界面
+
+![imys_translation3.png](./img/imys_translation3.png)
+
+修改後，按**Save and stay**即可 (PS: 進行修改需要註冊帳號)
+
+![imys_translation4.png](./img/imys_translation4.png)
+
+完成！