Merge branch 'main' of https://github.com/xiaopeng12138/MaiDXR

README.md

@@ -8,7 +8,7 @@ Discord: Coming Soon
 [Chinese 中文 README](https://github.com/xiaopeng12138/MaiDXR/blob/main/README_zh.md)
 
 
-## About this project
+**About this project**
 ---
 - This project is an update of https://github.com/xiaopeng12138/MaiMai-VR. 
 - Support DX version or above
@@ -20,18 +20,18 @@ Discord: Coming Soon
 - 3 customizable buttons
 
 
-## Preview
+**Preview**
 ---
 <img src="https://github.com/xiaopeng12138/MaiDXR/blob/main/PreviewImage/MaiDXR_PreviewImage.png?raw=true" width="250" />
 
 
-## Inspired by
+**Inspired by**
 ---
 - https://github.com/derole1/MaiMai-VR
 - https://github.com/HelloKS/MaiMai-VR
 
 
-## Used repository
+**Used repository**
 ---
 - [MaiMai-VR](https://github.com/HelloKS/MaiMai-VR)
 - [Mai2Touch](https://github.com/Sucareto/Mai2Touch)
@@ -45,30 +45,30 @@ Discord: Coming Soon
 **Special thanks to [@V17AMax](https://github.com/V17AMax) for the beautiful logo and designs**
 
 
-## Build requirements
+**Build requirements**
 ---
 - Current Unity version: 2021.3.8f1
 
 
-## Supported platform
+**Supported platform**
 ---
 - All SteamVR device (Index，HTC，Oculus)
 - All Oculus device (Oculus Desktop App)
 - Tested on Quest 2 through Oculus link (Native and via SteamVR) and ALVR (via SteamVR). The Hand Balls position is by default adjusted for the Quest 2 controller.
 
-## Declaimer
+**Declaimer**
 ---
 - This project is non-profit and some resources came from Internet!
 - Although this is under the MIT license, do not use this in commercial/profitable scenarios!
 - Please support your local arcade if you can!
 
 
-## Changelog
+**Changelog**
 ---
 Please see Changes.md
 
 
-## How to use
+**How to use**
 ---
 - Get game somehow and make sure it will run properly. (DO NOT ASK ANYTHING THAT IS DIRECTLY RELATED TO THE GAME IT SELF)
 - Download [latest version of MaiDXR](https://github.com/xiaopeng12138/MaiDXR/releases)
@@ -82,7 +82,7 @@ Please see Changes.md
 - If your touch is not working, try to enable somehow Test mod then exit Test mode.
 
 
-## Configuration
+**Configuration**
 ---
 The green button on the bottom of the cabinet is lock button. Long press it will disable all unnecessary buttons, controller pointer, and the config panel.
 
@@ -94,11 +94,11 @@ Some configs in config.json are only the index of the dropdown.
 
 You can use the pointer to point the third-person camera and grab it to the position where you want to be.
 
-## Multiplayer Configuration
+**Multiplayer Configuration**
 ---
 All the settings related to multiplayer are inside config.json.
 
-- **HostIP:** IP address of the host to be connected by the client, supports IPV4/6.IPV6 format: **HostIP: "[fe80::1145:1400:1919:8100]"** 
+- **HostIP:** IP address of the host to be connected by the client, supports IPV4/6. IPV6 format: **HostIP: "[fe80::1145:1400:1919:8100]"** 
 - **HostPort:** the port of the host, also the port to which the client will connect. The protocol is UDP.
 - If you need to forward the port on top of the router, you only need to forward one of the above UDP ports.
 
@@ -110,7 +110,7 @@ All the settings related to multiplayer are inside config.json.
 
 **Too high bit rate and resolution will cause all kinds of lag and issues, it is recommended to divide the resolution by 3 and adjust the frame rate to less than 20 fps, which can solve the problem of compression mosaic and encoding lag to some extent.**
 
-## ToDo
+ToDo
 ---
 - √ Add user-adjustable settings (controller position etc.)
 - √ Add non-VR window and camera smooth

README_zh.md

@@ -6,7 +6,7 @@
 交流Discord：Coming Soon
 
 
-## 关于这个项目
+关于这个项目
 ---
 - 本项目是https://github.com/xiaopeng12138/MaiMai-VR 的重置更新
 - 支持DX版本或以上
@@ -18,18 +18,18 @@
 - 3个可自定义的按钮
 
 
-## 预览
+预览
 ---
 <img src="https://github.com/xiaopeng12138/MaiDXR/blob/main/PreviewImage/MaiDXR_PreviewImage.png?raw=true" width="250" />
 
 
-## 灵感
+灵感
 ---
 - https://github.com/derole1/MaiMai-VR
 - https://github.com/HelloKS/MaiMai-VR
 
 
-## 使用的仓库
+使用的仓库
 ---
 - https://github.com/HelloKS/MaiMai-VR
 - https://github.com/hecomi/uWindowCapture
@@ -40,31 +40,31 @@
 **特别感谢[@V17AMax](https://github.com/V17AMax)设计的Logo以及风格设计**
 
 
-## 编译要求
+编译要求
 ---
 - 当前Unity版本：2021.3.8f1
 
 
-## 支持的平台
+支持的平台
 ---
 - 所有SteamVR设备（Index，HTC，Oculus）
 - 所有的Oculus设备（Oculus Desktop App)
 - 使用Oculus Link（原生和通过SteamVR）和ALVR（通过SteamVR）在Quest 2上测试过。手的位置是默认为Quest 2控制器调整的（其他控制器可能需要手动调整获得最佳体验）
 
 
-## 声明
+声明
 ---
 - 本项目为非营利性项目，部分资源来自互联网!
 - 虽然存储库是在MIT许可下的，但不要在商业/盈利的情况下使用它!
 - 如果可以的话，请支持你本地的机厅!
 
 
-## 更改日志
+更改日志
 ---
 请参见 Changes.md
 
 
-## 如何使用
+如何使用
 ---
 - 确保游戏本体可以正常游玩。(不要询问任何与游戏本身直接相关的问题！)
 - 下载[MaiDXR的最新版本](https://github.com/xiaopeng12138/MaiDXR/releases)
@@ -78,7 +78,7 @@
 - 如果你的触摸不起作用，请尝试以某种方式启用维护模式，然后退出维护模式。
 
 
-## 设置
+设置
 ---
 框体底部的绿色按钮是锁定按钮。 长按它将禁用所有不必要的按钮、手柄指针和配置面板。
 
@@ -91,7 +91,7 @@ config.json 中的一些配置的参数只是下拉列表选项的顺序。
 你可以使用控制器指针指向第三人称相机，并用手柄的抓取键将其放到你想要的位置。
 
 
-## 多人游玩设置
+多人游玩设置
 ---
 
 - 所有的多人游玩相关的设置都在config.json里面。
@@ -99,7 +99,7 @@ config.json 中的一些配置的参数只是下拉列表选项的顺序。
 - **HostPort:** 主机的端口，也是客户端要连接的端口。协议为UDP。
 - 如果你需要在路由器上面转发端口，只需要转发上述的一个UDP端口即可。
 
-EncoderSettin（编码设置）：
+EncoderSetting（编码设置）：
 
 - **bitRate:** 比特率（单位：bit；默认：196608）
 - **frameRate:** 帧率（单位：FPS；默认：24）
@@ -108,7 +108,7 @@ EncoderSettin（编码设置）：
 
 **过高的码率和分辨率会造成各种的问题和卡顿，推荐将分辨率除以3帧率调整为20帧以下，可以一定程度上解决压缩马赛克，以及编码卡顿问题。**
 
-## ToDo
+ToDo
 ---
 - √ 添加用户可调整的设置（控制器位置等）
 - √ 添加非VR窗口和摄像机的平滑度