From 7ac0a10829db4a4d590eccdcf5d0dc5b0ad0f2e6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8F=B2=E8=92=82=E5=A4=AB?= <steam114514@126.com>
Date: Sat, 4 Jan 2025 14:05:18 +0800
Subject: [PATCH] Update README.md

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1145f12..af74fba 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# MVPMusicBox
-SCP:SL MVP MusicBox Plugin
+# MVPMusicBox - MVP音乐盒插件🎵
+
+## **介绍:**
+
+该插件添加了MVP音乐盒🎵。
+
+当玩家击杀总数(不包括自杀)为回合第一时,会播放玩家MVP音乐盒。
+
+如果玩家没有MVP音乐盒,则仅显示信息而不会进行播放与提示。
+
+## **使用:**
+e
+将`dependencies-exiled.rar`解压至`EXILED\Plugins\dependencies`内
+
+然后将`MVPMusicBox.dll`放至`EXILED\Plugins`内
+
+服务器就会加载该插件了
+
+## **JSON配置教程:**
+
+插件进行加载时会在EXILED目录生成`音乐盒`文件夹📂
+
+在该文件夹内会生成`Config.json`文件📄和`音乐文件`文件夹📂
+
+`Config.json`用于储存玩家音乐盒配置文件📄
+
+`音乐文件`内放入音乐文件🎵
+
+`Config.json`配置示例:
+
+```
+[
+  {
+    "UserId": "[UserId]", //玩家64位 数字结尾加上@steam
+    "MusicName": "MyMusic", //从'音乐文件'文件夹加载的音乐名称,不需要后缀名
+    "BroadcastName": "[DEBUG]" //游戏内提示的名称,例如:正在播放[DEBUG]
+  }
+]
+```
+在回合开启和插件加载时插件会进行一次Json读取
+
+
+## **音乐文件要求:**
+
+音乐应为单轨道 48000采样率的ogg音频
+
+时间应在10秒内