mirror of
https://github.com/xiaopeng12138/MaiDXR.git
synced 2024-11-23 19:40:57 +01:00
update readme and changes
This commit is contained in:
parent
29e0795938
commit
17a49adae7
@ -20972,6 +20972,7 @@ MonoBehaviour:
|
||||
- {fileID: 1312793477}
|
||||
- {fileID: 452961286}
|
||||
- {fileID: 2047553882}
|
||||
- {fileID: 1540630978}
|
||||
LocalMotion: {fileID: 1616880711}
|
||||
RayObjects:
|
||||
- {fileID: 1461357245}
|
||||
|
34
CHANGES.md
34
CHANGES.md
@ -2,10 +2,20 @@
|
||||
|
||||
# Latest
|
||||
|
||||
## v0.7.2
|
||||
Possible to switch hand during hold #16
|
||||
## v0.8
|
||||
Switch to Unity2021 and URP
|
||||
|
||||
Fix display position
|
||||
New enviroment and logo
|
||||
|
||||
Add 2P cabinet
|
||||
|
||||
Add controll panel
|
||||
|
||||
Add lock to buttons and other stuff
|
||||
|
||||
Possible to adjust 3rd person camera via controller pointer in game
|
||||
|
||||
Touch backend is now in different thread
|
||||
|
||||
|
||||
# Old version
|
||||
@ -121,4 +131,20 @@ Add 1p only setting (reboot MaiDXR require)
|
||||
|
||||
Update readme to fix #14
|
||||
|
||||
Some small adjust
|
||||
Some small adjust
|
||||
|
||||
|
||||
## v0.7.2
|
||||
Possible to switch hand during hold #16
|
||||
|
||||
Fix display position
|
||||
|
||||
|
||||
## v0.7.3
|
||||
update touch and led serial backend
|
||||
|
||||
change the light type to spotlights
|
||||
|
||||
enable display light
|
||||
|
||||
add frame rate limit to none vr view
|
||||
|
BIN
PreviewImage/MaiDXR_Preview_Image.png
Normal file
BIN
PreviewImage/MaiDXR_Preview_Image.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 658 KiB |
@ -161,6 +161,7 @@ PlayerSettings:
|
||||
- {fileID: 0}
|
||||
- {fileID: 0}
|
||||
- {fileID: 0}
|
||||
- {fileID: 0}
|
||||
- {fileID: 6536100391545742739, guid: 55d1ec7a4296de343b6d3bb6f9a19731, type: 2}
|
||||
- {fileID: 0}
|
||||
- {fileID: -6018045015233401694, guid: 3999ab811e936714280a476b3a032d86, type: 2}
|
||||
|
46
README.md
46
README.md
@ -1,5 +1,7 @@
|
||||
# MaiDXR
|
||||
Open Source VR Arcade Simulator
|
||||
QQ Group: 261946477
|
||||
Discord: Coming Soon
|
||||
|
||||
[Chinese 中文 README](https://github.com/xiaopeng12138/MaiDXR/blob/main/README_zh.md)
|
||||
|
||||
@ -7,12 +9,11 @@ Open Source VR Arcade Simulator
|
||||
- This project is an update of https://github.com/xiaopeng12138/MaiMai-VR.
|
||||
- Support DX version or above
|
||||
- The model is almost 1:1 to DX cabinet/framework
|
||||
- Native touch input and light outupt
|
||||
- Using naative touch input and light outupt
|
||||
- 90hz or 120hz capture (Bitblt) (Thanks @Thalesalex for the recommendation)
|
||||
- Customizable haptic feedback
|
||||
- 3rd person camera and smooth camera
|
||||
- 4 customizable buttons (+ 1 select button)
|
||||
- only 1 player
|
||||
- 3 customizable buttons
|
||||
|
||||
## Inspired by
|
||||
- https://github.com/derole1/MaiMai-VR
|
||||
@ -22,6 +23,8 @@ Open Source VR Arcade Simulator
|
||||
- https://github.com/HelloKS/MaiMai-VR
|
||||
- https://github.com/hecomi/uWindowCapture
|
||||
- https://github.com/Sucareto/Mai2Touch
|
||||
- https://github.com/xiaopeng12138/WACVR
|
||||
|
||||
|
||||
## Build requirements
|
||||
- Current Unity version: 2021.3.2f1
|
||||
@ -44,37 +47,24 @@ Please see Changes.md
|
||||
- Download [latest version of MaiDXR](https://github.com/xiaopeng12138/MaiDXR/releases)
|
||||
- Download and install [com0com](https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/powersdr-iq/setup_com0com_W7_x64_signed.exe)
|
||||
- Configure com0com to bind COM3 and COM5 (it must be these two ports), COM4 and COM6 is optional (bind them will make your startup process faster).
|
||||
- You must enable the enable buffer option in com2com on both ports of all pairs. Otherwise, your MaiDXR will crash after the Unity logo.
|
||||
- Disable DummyTouchPanel in xxxx.ini.
|
||||
- You must enable the enable buffer option in com2com on both ports of all pairs. Otherwise, your MaiDXR will crash after the logo.
|
||||
- Disable DummyTouchPanel in mai2.ini.
|
||||
- If you need button light, pls bind COM21 to COM51 (it must be these two ports)(Do not disable DummyLED!).
|
||||
- Run the game in window mode by adding [Unity Standalone Player command line arguments](https://docs.unity3d.com/Manual/PlayerCommandLineArguments.html) in xxxxx.bat and make sure there is no black bar. Recommend setting for 1080p display: "xxxxxx.exe -screen-fullscreen 0 -screen-width 1170 -screen-height 1050"
|
||||
- Start MaiDXR.
|
||||
- Enable somehow Test mod then exit Test mode.
|
||||
- Start MaiDXR first then start the game.
|
||||
- If your touch is not working, try to enable somehow Test mod then exit Test mode.
|
||||
|
||||
## Configuration
|
||||
In MaiDXR window press "M" on the keyboard to toggle local motion on-off.
|
||||
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.
|
||||
|
||||
Edit Settings.json file under the root directory. Press F5 in the MaiDXR window or defocus then focus window again to update settings.
|
||||
You can adjust all settings in the config panel or via config.json. The changes of config.json will only apply after the MaiDXR reboot.
|
||||
|
||||
HandSize, HandPosition, PlayerHigh: in CM
|
||||
If you want to adjust the settings, please take a step back. The controller pointer will automatically be disabled when the controller are too close to the cabinet.
|
||||
|
||||
CaptureFrameRate, TouchRefreshRate: in FPS
|
||||
Some configs in config.json are only the index of the dropdown.
|
||||
|
||||
Capture1P: true (9:16 aspect ratio) or false (default) (2*9:16 aspect ratio)
|
||||
You can use the pointer to point the third-person camera and grab it to the position where you want to be.
|
||||
|
||||
CameraSmooth: 0.0 - 1.0, 1.0 = no smoothing
|
||||
|
||||
CameraFOV: in degree
|
||||
|
||||
CameraPosition: in M
|
||||
|
||||
To enable 3rd person mod: set CameraSmooth to 0 then move your headset to where your camera wants to be. Then focus/select MaiDXR window to lock position. You can show your head by enabling the setting below.
|
||||
|
||||
HapticDuration: in second
|
||||
|
||||
HapticAmplitude: 0.0 - 1.0, 1.0 = max vibration
|
||||
|
||||
SelectButton and Button(1-4: top to bottom): Pls see [VK Code](https://docs.microsoft.com/windows/win32/inputdev/virtual-key-codes). Some keys do not require "VK_" at the beginning.
|
||||
|
||||
## Preview
|
||||
![Image Capture](https://github.com/xiaopeng12138/MaiDXR/blob/main/PreviewImage/MaiDXR_PreviewImage.png?raw=true)
|
||||
@ -86,12 +76,12 @@ SelectButton and Button(1-4: top to bottom): Pls see [VK Code](https://docs.micr
|
||||
- √ Add button vibration
|
||||
- √ Add 3rd person camera
|
||||
- √ Add 2p
|
||||
- Add Multiplay
|
||||
- √ Add custom button
|
||||
- √ Support 1p only capture
|
||||
- Add visual touch and button feedback
|
||||
- √ Add in game setting panel
|
||||
- Add Multiplay
|
||||
- Add visual touch and button feedback
|
||||
|
||||
Huge thanks to HelloKS and derole1
|
||||
Huge thanks to HelloKS, derole1, and every one in BSAH
|
||||
|
||||
If you want to add any function pls commit PR, I will accept it as soon as possible and make a new build/release.
|
||||
|
50
README_zh.md
50
README_zh.md
@ -1,5 +1,7 @@
|
||||
# #MaiDXR
|
||||
一个开源的VR街机模拟器框体
|
||||
交流QQ群:261946477
|
||||
交流Discord:Coming Soon
|
||||
|
||||
## 关于这个项目
|
||||
- 本项目是https://github.com/xiaopeng12138/MaiMai-VR 的重置更新
|
||||
@ -9,8 +11,7 @@
|
||||
- 支持90hz或120hz捕获(Bitblt)(感谢@Thalesalex的推荐)
|
||||
- 可调整的震动反馈
|
||||
- 支持第三人称和平滑相机
|
||||
- 4个可自定义的按钮(+1个选择按钮)
|
||||
- 只有1p
|
||||
- 3个可自定义的按钮
|
||||
|
||||
## 灵感
|
||||
- https://github.com/derole1/MaiMai-VR
|
||||
@ -22,9 +23,7 @@
|
||||
- https://github.com/Sucareto/Mai2Touch
|
||||
|
||||
## 编译要求
|
||||
- 当前Unity版本:2020.3.30f1
|
||||
- [InputSimulator](https://www.nuget.org/packages/InputSimulator) (需要解压缩nuget包然后找到.dll文件并把它放到assets文件夹中)
|
||||
- [uWindowCapture](https://github.com/hecomi/uWindowCapture) (要在你的unity项目中导入它)
|
||||
- 当前Unity版本:2021.3.2f1
|
||||
|
||||
## 支持的平台
|
||||
- 所有SteamVR设备
|
||||
@ -44,39 +43,23 @@
|
||||
- 下载[MaiDXR的最新版本](https://github.com/xiaopeng12138/MaiDXR/releases)
|
||||
- 下载并安装[com0com](https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/powersdr-iq/setup_com0com_W7_x64_signed.exe)
|
||||
- 配置com0com,绑定COM3和COM5(必须是这两个端口),COM4和COM6是可选的(绑定会让启动变快)
|
||||
- 必须在com2com的两个端口上启用缓冲区选项(enable buffer),不然,MaiDXR会在显示完Unity标志后崩溃
|
||||
- 在 xxxx.ini中禁用DummyTouchPanel
|
||||
- 必须在com2com的两个端口上启用缓冲区选项(enable buffer),不然,MaiDXR会在显示完Logo后崩溃
|
||||
- 在 mai2.ini中禁用DummyTouchPanel
|
||||
- 如果你想要灯效,请将COM21和COM51绑定(必须是这两个端口,并且不要禁用DummyLED!)
|
||||
- 通过在xxxx.bat中添加[Unity Standalone Player command line arguments](https://docs.unity3d.com/Manual/PlayerCommandLineArguments.html)使本体在窗口模式下运行,并且确保没有任何黑边。1080p显示屏推荐的设置:"xxxxx.exe -screen-fullscreen 0 -screen-width 1170 -screen-height 1050"
|
||||
- 启动MaiDXR。
|
||||
- 进一遍维护模式(按下测试键),然后退出维护模式。
|
||||
- 启动MaiDXR后启动游戏本体。
|
||||
- 如果你的触摸不起作用,请尝试以某种方式启用维护模式,然后退出维护模式。
|
||||
|
||||
## 设置
|
||||
在MaiDXR窗口中按M键来开关移动。
|
||||
框体底部的绿色按钮是锁定按钮。 长按它将禁用所有不必要的按钮、手柄指针和配置面板。
|
||||
|
||||
编辑根目录下的Settings.json文件。在MaiDXR窗口中按F5刷新或重新选中MaiDXR的窗口也能刷新。
|
||||
你可以在设置面板或通过 config.json 调整所有设置。 config.json 的更改只会在 MaiDXR 重启后生效。
|
||||
|
||||
HandSize(手大小), HandPosition(手位置偏移), PlayerHigh(玩家高度): 单位为厘米
|
||||
如果你想调整设置,请向后退一步。 当手柄离框体太近时,手柄指针会自动消失。
|
||||
|
||||
CaptureFrameRate(捕获帧率), TouchRefreshRate(触摸帧率):单位为为帧
|
||||
config.json 中的一些配置的参数只是下拉列表选项的顺序。
|
||||
|
||||
Capture1PlayerOnly(仅捕获1p): "true" (捕获9:16长宽比) 或 "false" (默认) (两倍的9:16长宽比,也就是18:16)
|
||||
|
||||
CameraSmooth(摄像机平滑):0.0 到 1.0, 1.0 = 无平滑度
|
||||
|
||||
CameraFOV(相机视野):以度为单位
|
||||
|
||||
CameraPosition(相机位置偏移):以米为单位
|
||||
|
||||
启用第三人称模式:将CameraSmooth设置为0,然后把头显移动到你相机想放在的位置。最后刷新MaiDXR窗口以锁定位置。通过启用以下设置可以在第三人称中显示你的头部位置
|
||||
|
||||
ShowHeadCube(显示头部方块): "true" 或 "false" (默认)
|
||||
|
||||
HapticDuration(手柄震动时长): 以秒为单位
|
||||
|
||||
HapticAmplitude(手柄震动幅度): 0.0 - 1.0, 1.0 = 最大振动
|
||||
|
||||
SelectButton,Button(选择按钮和按钮)(1-4:从上到下):格式请看[VK代码](https://docs.microsoft.com/windows/win32/inputdev/virtual-key-codes),有些键不需要在开头加上 "VK_"
|
||||
你可以使用控制器指针指向第三人称相机,并用手柄的抓取键将其放到你想要的位置。
|
||||
|
||||
## 预览
|
||||
![Image Capture](https://github.com/xiaopeng12138/MaiDXR/blob/main/PreviewImage/MaiDXR_PreviewImage.png?raw=true)
|
||||
@ -87,10 +70,13 @@ SelectButton,Button(选择按钮和按钮)(1-4:从上到下):格
|
||||
- √ 添加按钮灯光
|
||||
- √ 添加按钮振动
|
||||
- √ 添加第三人称摄像机
|
||||
- 添加2p
|
||||
- √ 添加2p
|
||||
- √ 添加自定义按钮
|
||||
- √ 支持只捕捉1p
|
||||
- √ 添加游戏内设置面板
|
||||
- 添加多人联机系统
|
||||
- 添加可视化触摸反馈
|
||||
|
||||
非常感谢HelloKS和derole1 !
|
||||
非常感谢HelloKS,derole1和所有在BSAH的小伙伴们 !
|
||||
|
||||
如果你想添加任何功能,欢迎提交PR!我将尽快查看并光速打包新版本。
|
||||
|
Loading…
Reference in New Issue
Block a user