Skip to content

Latest commit

 

History

History
139 lines (131 loc) · 11.4 KB

File metadata and controls

139 lines (131 loc) · 11.4 KB

APIConfig

Global configuration for various features.

Properties

Name Type Description Notes
campaignStatus String The current platform-wide event taking place
disableBackgroundPreloads Boolean Toggles if certain assets are preloaded in the background
locationGiftingNonSubPrioEnabled Boolean Toggles whether users without a current VRC+ subscription are priority recipients for gift drops
voiceEnableDegradation Boolean Unknown, probably voice optimization testing
voiceEnableReceiverLimiting Boolean Unknown, probably voice optimization testing
accessLogsUrls APIConfigAccessLogsUrls
address String VRChat's office address
ageVerificationInviteVisible Boolean
ageVerificationP Boolean
ageVerificationStatusVisible Boolean
analysisMaxRetries Integer Max retries for avatar analysis requests
analysisRetryInterval Integer Interval between retries for avatar analysis requests
analyticsSegmentNewUIPctOfUsers Integer Unknown
analyticsSegmentNewUISalt String Unknown
announcements Set<APIConfigAnnouncement> Public Announcements
audioConfig APIConfigAudioConfig [optional]
availableLanguageCodes List<String> List of supported Languages
availableLanguages List<String> List of supported Languages
avatarPerfLimiter APIConfigAvatarPerfLimiter
chatboxLogBufferSeconds Integer Unknown
clientApiKey String apiKey to be used for all other requests
clientBPSCeiling Integer Unknown
clientDisconnectTimeout Integer Unknown
clientNetDispatchThread Boolean Unknown [optional]
clientNetDispatchThreadMobile Boolean Unknown
clientNetInThread Boolean Unknown [optional]
clientNetInThread2 Boolean Unknown [optional]
clientNetInThreadMobile Boolean Unknown [optional]
clientNetInThreadMobile2 Boolean Unknown [optional]
clientNetOutThread Boolean Unknown [optional]
clientNetOutThread2 Boolean Unknown [optional]
clientNetOutThreadMobile Boolean Unknown [optional]
clientNetOutThreadMobile2 Boolean Unknown [optional]
clientQR Integer Unknown [optional]
clientReservedPlayerBPS Integer Unknown
clientSentCountAllowance Integer Unknown
constants APIConfigConstants
contactEmail String VRChat's contact email
copyrightEmail String VRChat's copyright-issues-related email
copyrightFormUrl String VRChat's DMCA claim webform url
currentPrivacyVersion Integer Current version number of the Privacy Agreement
currentTOSVersion Integer Current version number of the Terms of Service
defaultAvatar String
defaultStickerSet String
devLanguageCodes List<String> Unknown [optional]
devSdkUrl String Link to download the development SDK, use downloadUrls instead
devSdkVersion String Version of the development SDK
disCountdown OffsetDateTime Unknown, &quot;dis&quot; maybe for disconnect?
disableAVProInProton Boolean Unknown [optional]
disableAvatarCopying Boolean Toggles if copying avatars should be disabled
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
disableCaptcha Boolean Unknown [optional]
disableCommunityLabs Boolean Toggles if the Community Labs should be disabled
disableCommunityLabsPromotion Boolean Toggles if promotion out of Community Labs should be disabled
disableEmail Boolean Unknown
disableEventStream Boolean Toggles if Analytics should be disabled.
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.
disableFrontendBuilds Boolean Unknown, probably toggles compilation of frontend web builds? So internal flag?
disableGiftDrops Boolean Toggles if gift drops should be disabled
disableHello Boolean Unknown
disableOculusSubs Boolean Toggles if signing up for Subscriptions in Oculus is disabled or not.
disableRegistration Boolean Toggles if new user account registration should be disabled.
disableSteamNetworking Boolean Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead.
disableTwoFactorAuth Boolean Toggles if 2FA should be disabled.
disableUdon Boolean Toggles if Udon should be universally disabled in-game.
disableUpgradeAccount Boolean Toggles if account upgrading &quot;linking with Steam/Oculus&quot; should be disabled.
downloadLinkWindows String Download link for game on the Oculus Rift website.
downloadUrls APIConfigDownloadURLList
dynamicWorldRows Set<DynamicContentRow> Array of DynamicWorldRow objects, used by the game to display the list of world rows
economyLedgerBackfill Boolean Unknown
economyLedgerMigrationStop String Unknown
economyLedgerMode String Unknown
economyPauseEnd OffsetDateTime Unknown
economyPauseStart OffsetDateTime Unknown
economyPurchaseRepairEnabled Boolean Unknown
economyState Integer Unknown
events APIConfigEvents
forceUseLatestWorld Boolean Unknown
giftDisplayType String Display type of gifts
googleApiClientId String Unknown
homeWorldId String WorldID be &quot;offline&quot; on User profiles if you are not friends with that user.
homepageRedirectTarget String Redirect target if you try to open the base API domain in your browser
hubWorldId String WorldID be &quot;offline&quot; on User profiles if you are not friends with that user.
imageHostUrlList List<String> A list of explicitly allowed origins that worlds can request images from via the Udon's VRCImageDownloader#DownloadImage.
iosAppVersion List<String> Current app version for iOS
iosVersion APIConfigIosVersion
jobsEmail String VRChat's job application email
maxUserEmoji Integer The maximum number of custom emoji each user may have at a given time.
maxUserStickers Integer The maximum number of custom stickers each user may have at a given time.
minSupportedClientBuildNumber APIConfigMinSupportedClientBuildNumber
minimumUnityVersionForUploads String Minimum Unity version required for uploading assets
moderationEmail String VRChat's moderation related email
notAllowedToSelectAvatarInPrivateWorldMessage String Used in-game to notify a user they aren't allowed to select avatars in private worlds
offlineAnalysis APIConfigOfflineAnalysis
photonNameserverOverrides List<String> Unknown
photonPublicKeys List<String> Unknown
playerUrlResolverSha1 String Currently used youtube-dl.exe hash in SHA1-delimited format
playerUrlResolverVersion String Currently used youtube-dl.exe version
publicKey String Public key, hex encoded
reportCategories Map<String, ReportCategory> Categories available for reporting objectionable content
reportFormUrl String URL to the report form
reportOptions Map<String, Map<String, List<String>>> Options for reporting content. Select a key+value from this mapping as the `type` of the report. Select one key+value from the object at reportOptions[type] as the `category` of the report. reportCategories[category] contains user-facing text to display for all possible categories. Select one value from the array at reportOptions[type][category] as the `reason` of the report. reportReasons[reason] contains user-facing text to display for all possible categories.
reportReasons Map<String, ReportReason> Reasons available for submitting a report
requireAgeVerificationBetaTag Boolean
sdkDeveloperFaqUrl String Link to the developer FAQ
sdkDiscordUrl String Link to the official VRChat Discord
sdkNotAllowedToPublishMessage String Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet
sdkUnityVersion String Unity version supported by the SDK
stringHostUrlList List<String> A list of explicitly allowed origins that worlds can request strings from via the Udon's VRCStringDownloader.LoadUrl.
supportEmail String VRChat's support email
supportFormUrl String VRChat's support form
timeOutWorldId String WorldID be &quot;offline&quot; on User profiles if you are not friends with that user.
timekeeping Boolean Unknown
tutorialWorldId String WorldID be &quot;offline&quot; on User profiles if you are not friends with that user.
updateRateMsMaximum Integer Unknown
updateRateMsMinimum Integer Unknown
updateRateMsNormal Integer Unknown
updateRateMsUdonManual Integer Unknown
uploadAnalysisPercent Integer Unknown
urlList List<String> List of allowed URLs that bypass the &quot;Allow untrusted URL's&quot; setting in-game
useReliableUdpForVoice Boolean Unknown
viveWindowsUrl String Download link for game on the Steam website.
websocketMaxFriendsRefreshDelay Integer Unknown
websocketQuickReconnectTime Integer Unknown
websocketReconnectMaxDelay Integer Unknown
whiteListedAssetUrls List<String> List of allowed URLs that are allowed to host avatar assets