Skip to content

Commit

Permalink
Updated Readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
@Raphiiko
Raphiiko committed Jun 18, 2024
1 parent 7e947e5 commit 49ca1b7
Show file tree
Hide file tree
Showing 28 changed files with 1,365 additions and 242 deletions.
155 changes: 142 additions & 13 deletions docs/readmes/generated/README_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
</table>
</p>
<p align="center">
<img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/597f53c7-73b8-46bb-a118-96dccae6730c" width="640">
<img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/563abe4d-2a8d-43e2-9515-39ea8d772d09" width="640">
</p>

## 下载与安装
Expand All @@ -98,6 +98,7 @@ OyasumiVR可以**检测你何时入睡**，并以各种方式帮助你，例如
- 🔅 调暗你头显的亮度
- ✨ 根据你的睡姿触发模型的不同动画
- 📩 自动处理加入请求
- 🔵 Automating your VRChat status
- 🎤 当你睡着时关闭你的麦克风
- 🛠️ 自动化各种各样的操作，例如关闭你的设备，或者调整你的GPU功耗限制

Expand Down Expand Up @@ -130,9 +131,12 @@ OyasumiVR可以根据你的动作自动检测你何时入睡！只需一次校
<li>根据控制器和追踪器的电量启用/禁用睡眠模式</li>
<li>根据控制器和追踪器的开关状态来启用/禁用睡眠模式</li>
<li>根据SteamVR的状态来进行模式切换</li>
<li>Heart Rate</li>
<li>Sitting Upright</li>
<li>VRChat players joining or leaving</li>
</ul>
</td>
<td width="380"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/cfe464c4-129b-4441-a54c-5ec489b002e2"></td>
<td width="380"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/48775fe7-2646-4d0b-ba8c-f7d7eb3a5d86"></td>
</tr>
</table>

Expand Down Expand Up @@ -183,6 +187,18 @@ OyasumiVR拥有自己的SteamVR叠加层界面，可以让你在VR里玩游戏
</tr>
</table>

### 🎮 Device Control
<table>
<tr>
<td>
OyasumiVR can allow you to easily control many of your SteamVR devices, from controllers, to trackers, to base stations.
<br><br>
Easily read detailed battery level and charge status for your controllers and trackers, or turn your base stations on and off with a single click!
</td>
<td width="380"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/7c6a6f7d-fa5a-44e0-bc0f-b690e26dad31"></td>
</tr>
</table>

### 🔌 GPU自动化

<table>
Expand Down Expand Up @@ -244,20 +260,46 @@ OyasumiVR可以检测你的睡眠姿势，并触发你模型上不同的动画
<br>
当你睡觉时，自动处理朋友们的加入请求！你可以将你想让他们进入的朋友添加到白名单，或者使用黑名单阻止某些朋友的请求被自动接受。
</td>
<td width="380" colspan="2"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/a3778498-b3e4-464a-af91-1f9b74bf134e"></td>
<td width="380" colspan="2"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/0b96c76a-4ecb-415d-a446-0430f9e0c233"></td>
</tr>
<tr>
<td>
🔵 <b>状态自动化</b>
🔵 <b>Status Automations</b>
<br>
根据世界中的人数自动改变你的状态：
OyasumiVR offers multiple automations for controlling your VRChat visibility and status message, like when you fall asleep, or wake up!
<br><br>
当你独自睡觉时切换到蓝色（加入我），这样你的朋友可以加入你，当周围有足够的人时切换到橙色（询问我）！
Additionally, you can have OyasumiVR automatically switch your status based on the amount of people around you in VRChat. For example: Switch to blue when you are sleeping alone so your friends can join you, and switch to orange when there's enough people around!
</td>
<td width="380" colspan="2"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/8ff25c9c-8888-4c12-b149-1f68db17eb01"></td>
</tr>
<tr>
<td>
🔔 <b>Join Notifications</b>
<br>
OyasumiVR can notify you when people join or leave your VRChat world. This is useful if you want to be woken up in certain situations.

It can configured to only notify you in specific situations, like only:
<br>
<ul>
<li>For your friends</li>
<li>For certain specific players</li>
<li>When you're being left alone</li>
<li>When you're no longer alone</li>
</ul>
</td>
<td width="380" colspan="2"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/bc2e2f9b-9ee5-402c-a7a7-8b998af7d81f"></td>
</tr>
<tr>
<td>
🏃 <b>Avatar Automations</b>
<br>
You can have OyasumiVR automatically switch your avatar when you prepare for bed, when you fall asleep, or when you wake up!
Useful if you have a specific avatar you use for sleeping.
</td>
<td width="380" colspan="2"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/e492c6e7-ddda-44ba-b62a-768b01729bdd"></td>
</tr>
<tr>
<td>
🔧 <b>OSC自动化</b>
<br>
当睡眠模式启用（或禁用）时，你可以发送某些OSC指令到VRChat。你可以使用内置的OSC脚本编辑器来编写你想要发送的确切指令。
Expand All @@ -273,18 +315,25 @@ OyasumiVR可以检测你的睡眠姿势，并触发你模型上不同的动画
<table>
<tr>
<td>
你是否曾经想在VR中入睡，但又不想整夜待在VR中？关机序列可以帮你解决这个问题！
Ever wanted to fall asleep in VR, but not stay in VR all night? The shutdown sequence has you covered!
<br><br>
当你睡着一段时间后，这个功能可以被自动触发。根据你的配置，它可能会执行以下操作：
While you can trigger the shutdown sequence manually, there are several automated triggers you can configure:
<br><br>
<ul>
<li>关闭你的控制器和追踪器</li>
<li>关闭你的基站</li>
<li>退出SteamVR <i>（以及任何正在运行的游戏或叠加层）</i></li>
<li>关闭你的电脑</li>
<li>When you've been asleep for a certain amount of time. </li>
<li>When you're left alone in your VRChat world for a certain amount of time.</li>
</ul>
<br>
现在你可以安心地在VR中入睡，在你熟睡后，你选择的设备都会关闭！
Depending on which actions you configure, it will do any of the following:
<br><br>
<ul>
<li>Turn off your controllers and/or Trackers</li>
<li>Turn off your Base Stations</li>
<li>Quit SteamVR <i>(And any running game or overlay along with it)</i></li>
<li>Shut down Windows</li>
</ul>
<br>
With the shutdown sequence configured, you can fall asleep soundly in VR, knowing that everything will shut down when you don't need to be in VR anymore!
</td>
<td width="380"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/4254eb51-6d40-4200-a8ef-af97279a9072"></td>
</tr>
Expand Down Expand Up @@ -406,6 +455,86 @@ OyasumiVR has various automations for controlling certain features specific to c
</tr>
</table>

### 🏠 Home Assistant Integration

<table>
<tr>
<td colspan="2">
<img width="100" align="right" src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/88eff4c6-a251-43f8-9759-baecedf94a32"><br>
OyasumiVR can expose many of its own features, as well as SteamVR's, to Home Assistant over MQTT! This allows you to integrate OyasumiVR with various smart devices you might have in your home, as well as enable you to build your own powerful automations within Home Assistant.
For example, you can use this to automatically turn off your smart lights when you fall asleep, or turn them back on when needed!
<br><br>
Here is a list of features exposed that you'll be able to read, or control, through Home Assistant:
</td>
<td width="380"><img src="https://github.com/Raphiiko/OyasumiVR/assets/111654848/0476e18c-5509-4b08-932f-f49b943d9965"></td>
</tr>
<tr>
<td>
<b>OyasumiVR Features</b>
<ul>
<li>Sleep Mode (Switch)</li>
<li>Shutdown Sequence (Button)</li>
<li>Sleep Preparation (Button)</li>
<li>Heart Rate (Sensor)</li>
<li>Sleeping Position (Sensor)</li>
<li>
Base Station
<ul>
<li>Power (Switch)</li>
<li>Power State (Sensor)</li>
</ul>
</li>
<li>
HMD Brightness
<ul>
<li>Advanced Mode (Switch)</li>
<li>Simple Brightness (Number)</li>
<li>Software Brightness (Number)</li>
<li>Hardware Brightness (Number)</li>
</ul>
</li>
</ul>
</td>
<td colspan="2">
<b>VRChat Features</b>
<ul>
<li>VRChat Running (Sensor)</li>
<li>Player Name (Sensor)</li>
<li># Players In World (Sensor)</li>
<li>Status Visibility (Sensor)</li>
<li>World Instance ID (Sensor)</li>
</ul>
</td>
</tr>
<tr>
<td>
<b>SteamVR Features</b>
<ul>
<li>VR Headset Model (Sensor)</li>
<li>SteamVR Running (Sensor)</li>
<li>
Controller & Tracker
<ul>
<li>Power (Switch) (Only Powering Off)</li>
<li>Charging State (Sensor)</li>
<li>Battery Level (Sensor)</li>
<li>Device Roles (Sensor)</li>
</ul>
</li>
</ul>
<br />
</td>
<td colspan="2">
<b>Bigscreen Beyond Features</b>
<ul>
<li>Fan Speed (Number)</li>
<li>RGB LED (Light)</li>
<li>Brightness (Number)</li>
</ul>
</td>
</tr>
</table>

## 翻译和本地化

OyasumiVR目前支持以下语言：
Expand Down
Loading

0 comments on commit 49ca1b7

Please sign in to comment.