# vsvrsdk

**Repository Path**: vswork_admin/vsvrsdk

## Basic Information

- **Project Name**: vsvrsdk
- **Description**: VSVR Scene Maker SDK Project and Examples
- **Primary Language**: C#
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 19
- **Forks**: 6
- **Created**: 2020-07-13
- **Last Updated**: 2025-06-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 一、环境搭建
### 1. 开发环境
unity版本： 使用 **unity2022.3.54**  版本
### 2. VSVRSDK 环境搭建
###### 2.1.1  注册并登录 check到本地 或直接下载 zip工程包
> https://gitee.com/vswork_admin/vsvrsdk

或

> https://github.com/VSWORK-admin/vsvrsdk

## 二、 unity3d 的 不同发布平台的设置需求：

Android :
```
## Build Setting -> 
TextureCompression : ASTC 

## PlayerSetting -> OtherSettings:
ColorSpace : Linear
AutoGraphics API : true
GraphicsAPIs :  OpenGLES3 + Vulkan
LightmapEncoding : High Quality 
LightmapStreaming Enabled : True 
Allow 'unsafe' Code : True

## PlayerSetting-> XR Settings:
Virtual Reality Supported : True
VirtualRealitySDKs : none
Stereo Rendering Mode : SinglePass
```

iOS:
```
## PlayerSetting -> OtherSettings: 
ColorSpace : Linear
Auto Graphics API  : False 
GraphicsAPIs : Metal
LightmapEncoding : High Quality 
LightmapStreaming Enabled : True
Allow 'unsafe' Code : True

## PlayerSetting -> XR Settings: 
Virtual Reality Supported : False
```

Windows:
```
## Build Setting -> 
TargetPlatform : Windows
Architecture : x86_64 

## PlayerSetting -> OtherSettings: 
ColorSpace : Linear
AutoGraphics API for Windows : True 
LightmapEncoding : High Quality 
LightmapStreaming Enabled : True
Allow 'unsafe' Code : True

## PlayerSetting -> XR Settings: 
Virtual Reality Supported : True
VirtualRealitySDKs : none
Stereo Rendering Mode : SinglePass
```

macOS:
```
## Build Setting -> 
TargetPlatform : Mac OS X

## PlayerSetting -> OtherSettings: 
ColorSpace : Linear
AutoGraphics API for Mac : True
LightmapEncoding : High Quality 
LightmapStreaming Enabled : True
Allow 'unsafe' Code : True

## PlayerSetting -> XR Settings: 
Virtual Reality Supported : False
```



## 三、场景设置
###### 3.1. 场景内使用URP渲染管线
###### 3.2. 场景内不能引入其他第三方插件，除了 VRSDK 外，其他插件需要在打包时移除。
###### 3.3. 场景内的材质使用  URP 中的Shader，不要使用其他Shader
###### 3.4. 场景内尽量不使用实时灯光，场景中需要添加 Light Probe Group （光照探针）用来给动态物体提供光环境
###### 3.5. 场景内尽量少使用法线贴图，使用的图片大小尺寸避免过大造成渲染资源浪费
###### 3.6. 场景内的图片和光照贴图尽可能的在打包之前设置到最小分辨率，Android 和 iOS 设置为 ASTC 6x6 压缩格式

## 四、出生点 和 场景内的物体设置
###### 4.1.位置点 、位置组 、位置面
```
（1）_VSVRSDK -》 _Bundle_Prefab -》 _StartPoint	拖入到场景中设置角色出生点
（2）在允许自由走动的平面上 添加 meshcollider 或者 boxcollider 然后添加 VRPlayceMeshMark 脚本到该物体上。
```

## 五、场景打包
###### 5.1. 打包名称设置
> 将需要打包的场景设置AssetBundle ：设置bundle的名称和后缀（scene），也可以打包后将文件后缀名改为 .scene 
###### 5.2. 资源检查
> 打开 Window -》 AssetBundle Browser	以Size排序 ，检查避免出现多余的文件和过大的文件（主要是过大的图片，需要使用外部图片编辑软件改变图片格式，如果有Alpha通道则建议改为png格式，如果没有Alpha通道则建议改为jpg格式）
###### 5.3. 打包平台选择

- Android平台所需场景文件 需要在AssetBundle Browser 中 BuildTartget 设置为 **Android**

- iOS 平台需要设置为 **iOS**

- Window平台运行场景需要设置为 **Standalone Windows**

- MacOS 平台运行需要设置为  **Standalone OSX Universal**

**建议打开Unity的CacheServer ： Edit -> Preferences -> CacheServer -> Cache Server Mode  选择 Local， 以避免平台的切换导致的资源重复加载，节省不同平台assetbundle在同一个工程打包的时间。**


## 六、交互编程 和 代码调试
> 支持使用 VScode  或者 Visual Studio  进行开发，开发语言 ：C#。

示例工程和说明文档(gitee)： 
- VScode：https://gitee.com/vswork_admin/vsvrsdk/tree/master/ILruntimeSample_VScode
- Visual Studio ： https://gitee.com/vswork_admin/vsvrsdk/tree/master/ILruntimeSample_VisualStudio

示例工程和说明文档(github)： 
- VScode：https://github.com/VSWORK-admin/vsvrsdk/tree/master/ILruntimeSample_VScode
- Visual Studio ： https://github.com/VSWORK-admin/vsvrsdk/tree/master/ILruntimeSample_VisualStudio

```