|
1 | 1 |
|
2 | 2 |
|
3 | | -# Config |
| 3 | +# APIConfig |
4 | 4 |
|
5 | 5 |
|
6 | 6 | ## Properties |
7 | 7 |
|
8 | 8 | Name | Type | Description | Notes |
9 | 9 | ------------ | ------------- | ------------- | ------------- |
10 | | -**address** | **String** | VRChat's office address | [readonly] |
11 | | -**announcements** | [**Set<ConfigAnnouncements>**](ConfigAnnouncements.md) | Public Announcements | [readonly] |
12 | | -**apiKey** | **String** | apiKey to be used for all other requests | [readonly] |
13 | | -**appName** | **String** | Game name | [readonly] |
14 | | -**buildVersionTag** | **String** | Build tag of the API server | [readonly] |
15 | | -**clientApiKey** | **String** | apiKey to be used for all other requests | [readonly] |
16 | | -**clientBPSCeiling** | **BigDecimal** | Unknown | [optional] |
17 | | -**clientDisconnectTimeout** | **BigDecimal** | Unknown | [optional] |
18 | | -**clientReservedPlayerBPS** | **BigDecimal** | Unknown | [optional] |
19 | | -**clientSentCountAllowance** | **BigDecimal** | Unknown | [optional] |
20 | | -**contactEmail** | **String** | VRChat's contact email | [readonly] |
21 | | -**copyrightEmail** | **String** | VRChat's copyright-issues-related email | [readonly] |
22 | | -**currentTOSVersion** | **BigDecimal** | Current version number of the Terms of Service | [readonly] |
| 10 | +**voiceEnableDegradation** | **Boolean** | Unknown, probably voice optimization testing | |
| 11 | +**voiceEnableReceiverLimiting** | **Boolean** | Unknown, probably voice optimization testing | |
| 12 | +**address** | **String** | VRChat's office address | |
| 13 | +**announcements** | [**Set<PublicAnnouncement>**](PublicAnnouncement.md) | Public Announcements | |
| 14 | +**apiKey** | **String** | apiKey to be used for all other requests | |
| 15 | +**appName** | **String** | Game name | |
| 16 | +**buildVersionTag** | **String** | Build tag of the API server | |
| 17 | +**clientApiKey** | **String** | apiKey to be used for all other requests | |
| 18 | +**clientBPSCeiling** | **Integer** | Unknown | |
| 19 | +**clientDisconnectTimeout** | **Integer** | Unknown | |
| 20 | +**clientReservedPlayerBPS** | **Integer** | Unknown | |
| 21 | +**clientSentCountAllowance** | **Integer** | Unknown | |
| 22 | +**contactEmail** | **String** | VRChat's contact email | |
| 23 | +**copyrightEmail** | **String** | VRChat's copyright-issues-related email | |
| 24 | +**currentTOSVersion** | **Integer** | Current version number of the Terms of Service | |
23 | 25 | **defaultAvatar** | **String** | | |
24 | 26 | **deploymentGroup** | **DeploymentGroup** | | |
25 | | -**devAppVersionStandalone** | **String** | Version number for game development build | [readonly] |
26 | | -**devDownloadLinkWindows** | **String** | Developer Download link | [readonly] |
27 | | -**devSdkUrl** | **String** | Link to download the development SDK, use downloadUrls instead | [readonly] |
28 | | -**devSdkVersion** | **String** | Version of the development SDK | [readonly] |
29 | | -**devServerVersionStandalone** | **String** | Version number for server development build | [readonly] |
| 27 | +**devAppVersionStandalone** | **String** | Version number for game development build | |
| 28 | +**devDownloadLinkWindows** | **String** | Developer Download link | |
| 29 | +**devSdkUrl** | **String** | Link to download the development SDK, use downloadUrls instead | |
| 30 | +**devSdkVersion** | **String** | Version of the development SDK | |
| 31 | +**devServerVersionStandalone** | **String** | Version number for server development build | |
| 32 | +**disCountdown** | **OffsetDateTime** | Unknown, \"dis\" maybe for disconnect? | |
30 | 33 | **disableAvatarCopying** | **Boolean** | Toggles if copying avatars should be disabled | |
31 | 34 | **disableAvatarGating** | **Boolean** | Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag | |
32 | 35 | **disableCommunityLabs** | **Boolean** | Toggles if the Community Labs should be disabled | |
33 | 36 | **disableCommunityLabsPromotion** | **Boolean** | Toggles if promotion out of Community Labs should be disabled | |
34 | | -**disableEmail** | **Boolean** | Unknown | [optional] |
35 | | -**disableEventStream** | **Boolean** | Toggles if Analytics should be disabled (this sreportedly not used in the Client) | |
| 37 | +**disableEmail** | **Boolean** | Unknown | |
| 38 | +**disableEventStream** | **Boolean** | Toggles if Analytics should be disabled. | |
36 | 39 | **disableFeedbackGating** | **Boolean** | Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag. | |
37 | | -**disableHello** | **Boolean** | Unknown | [optional] |
38 | | -**disableRegistration** | **Boolean** | Toggles if new user account registration should be disabled | |
| 40 | +**disableFrontendBuilds** | **Boolean** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | |
| 41 | +**disableHello** | **Boolean** | Unknown | |
| 42 | +**disableOculusSubs** | **Boolean** | Toggles if signing up for Subscriptions in Oculus is disabled or not. | |
| 43 | +**disableRegistration** | **Boolean** | Toggles if new user account registration should be disabled. | |
39 | 44 | **disableSteamNetworking** | **Boolean** | Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead. | |
40 | 45 | **disableTwoFactorAuth** | **Boolean** | Toggles if 2FA should be disabled. | |
41 | 46 | **disableUdon** | **Boolean** | Toggles if Udon should be universally disabled in-game. | |
42 | 47 | **disableUpgradeAccount** | **Boolean** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | |
43 | | -**downloadLinkWindows** | **String** | Download link for game on the Oculus Rift website. | [readonly] |
44 | | -**downloadUrls** | [**ConfigDownloadUrls**](ConfigDownloadUrls.md) | | |
45 | | -**dynamicWorldRows** | [**Set<ConfigDynamicWorldRows>**](ConfigDynamicWorldRows.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | [readonly] |
46 | | -**events** | [**ConfigEvents**](ConfigEvents.md) | | |
47 | | -**gearDemoRoomId** | **String** | Unknown | [readonly] |
48 | | -**homepageRedirectTarget** | **String** | Redirect target if you try to open the base API domain in your browser | [readonly] |
| 48 | +**downloadLinkWindows** | **String** | Download link for game on the Oculus Rift website. | |
| 49 | +**downloadUrls** | [**DownloadURLList**](DownloadURLList.md) | | |
| 50 | +**dynamicWorldRows** | [**Set<DynamicWorldRow>**](DynamicWorldRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | |
| 51 | +**events** | [**APIEventConfig**](APIEventConfig.md) | | |
| 52 | +**gearDemoRoomId** | **String** | Unknown | |
49 | 53 | **homeWorldId** | **String** | | |
| 54 | +**homepageRedirectTarget** | **String** | Redirect target if you try to open the base API domain in your browser | |
50 | 55 | **hubWorldId** | **String** | | |
51 | | -**jobsEmail** | **String** | VRChat's job application email | [readonly] |
52 | | -**messageOfTheDay** | **String** | MOTD | [readonly] |
53 | | -**moderationEmail** | **String** | VRChat's moderation related email | [readonly] |
54 | | -**moderationQueryPeriod** | **BigDecimal** | Unknown | |
55 | | -**notAllowedToSelectAvatarInPrivateWorldMessage** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | [readonly] |
56 | | -**plugin** | **String** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | [readonly] |
57 | | -**releaseAppVersionStandalone** | **String** | Version number for game release build | [readonly] |
58 | | -**releaseSdkUrl** | **String** | Link to download the release SDK | [readonly] |
59 | | -**releaseSdkVersion** | **String** | Version of the release SDK | [readonly] |
60 | | -**releaseServerVersionStandalone** | **String** | Version number for server release build | [readonly] |
61 | | -**sdkDeveloperFaqUrl** | **String** | Link to the developer FAQ | [readonly] |
62 | | -**sdkDiscordUrl** | **String** | Link to the official VRChat Discord | [readonly] |
63 | | -**sdkNotAllowedToPublishMessage** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | [readonly] |
64 | | -**sdkUnityVersion** | **String** | Unity version supported by the SDK | [readonly] |
65 | | -**serverName** | **String** | Server name of the API server currently responding | [readonly] |
66 | | -**supportEmail** | **String** | VRChat's support email | [readonly] |
| 56 | +**jobsEmail** | **String** | VRChat's job application email | |
| 57 | +**messageOfTheDay** | **String** | MOTD | |
| 58 | +**moderationEmail** | **String** | VRChat's moderation related email | |
| 59 | +**moderationQueryPeriod** | **Integer** | Unknown | |
| 60 | +**notAllowedToSelectAvatarInPrivateWorldMessage** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | |
| 61 | +**plugin** | **String** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | |
| 62 | +**releaseAppVersionStandalone** | **String** | Version number for game release build | |
| 63 | +**releaseSdkUrl** | **String** | Link to download the release SDK | |
| 64 | +**releaseSdkVersion** | **String** | Version of the release SDK | |
| 65 | +**releaseServerVersionStandalone** | **String** | Version number for server release build | |
| 66 | +**sdkDeveloperFaqUrl** | **String** | Link to the developer FAQ | |
| 67 | +**sdkDiscordUrl** | **String** | Link to the official VRChat Discord | |
| 68 | +**sdkNotAllowedToPublishMessage** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | |
| 69 | +**sdkUnityVersion** | **String** | Unity version supported by the SDK | |
| 70 | +**serverName** | **String** | Server name of the API server currently responding | |
| 71 | +**supportEmail** | **String** | VRChat's support email | |
67 | 72 | **timeOutWorldId** | **String** | | |
68 | 73 | **tutorialWorldId** | **String** | | |
69 | | -**updateRateMsMaximum** | **BigDecimal** | Unknown | [readonly] |
70 | | -**updateRateMsMinimum** | **BigDecimal** | Unknown | [readonly] |
71 | | -**updateRateMsNormal** | **BigDecimal** | Unknown | [readonly] |
72 | | -**updateRateMsUdonManual** | **BigDecimal** | Unknown | [readonly] |
73 | | -**uploadAnalysisPercent** | **BigDecimal** | Unknown | [readonly] |
74 | | -**urlList** | **List<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | [readonly] |
| 74 | +**updateRateMsMaximum** | **Integer** | Unknown | |
| 75 | +**updateRateMsMinimum** | **Integer** | Unknown | |
| 76 | +**updateRateMsNormal** | **Integer** | Unknown | |
| 77 | +**updateRateMsUdonManual** | **Integer** | Unknown | |
| 78 | +**uploadAnalysisPercent** | **Integer** | Unknown | |
| 79 | +**urlList** | **List<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | |
75 | 80 | **useReliableUdpForVoice** | **Boolean** | Unknown | |
76 | | -**userUpdatePeriod** | **BigDecimal** | Unknown | [readonly] |
77 | | -**userVerificationDelay** | **BigDecimal** | Unknown | [readonly] |
78 | | -**userVerificationRetry** | **BigDecimal** | Unknown | [readonly] |
79 | | -**userVerificationTimeout** | **BigDecimal** | Unknown | [readonly] |
80 | | -**viveWindowsUrl** | **String** | Download link for game on the Steam website. | [readonly] |
81 | | -**whiteListedAssetUrls** | **List<String>** | List of allowed URLs that are allowed to host avatar assets | [readonly] |
82 | | -**worldUpdatePeriod** | **BigDecimal** | Unknown | [readonly] |
83 | | -**youtubedlHash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format | [readonly] |
84 | | -**youtubedlVersion** | **String** | Currently used youtube-dl.exe version | [readonly] |
| 81 | +**userUpdatePeriod** | **Integer** | Unknown | |
| 82 | +**userVerificationDelay** | **Integer** | Unknown | |
| 83 | +**userVerificationRetry** | **Integer** | Unknown | |
| 84 | +**userVerificationTimeout** | **Integer** | Unknown | |
| 85 | +**viveWindowsUrl** | **String** | Download link for game on the Steam website. | |
| 86 | +**whiteListedAssetUrls** | **List<String>** | List of allowed URLs that are allowed to host avatar assets | |
| 87 | +**worldUpdatePeriod** | **Integer** | Unknown | |
| 88 | +**youtubedlHash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format | |
| 89 | +**youtubedlVersion** | **String** | Currently used youtube-dl.exe version | |
85 | 90 |
|
86 | 91 |
|
87 | 92 |
|
0 commit comments