Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4f6cb22

Browse files
themonthofjunethemonthofjune
committed
Update RemoteConfig.md - reworded things, added missing fields
1 parent 442b8f0 commit 4f6cb22

File tree

1 file changed

+52
-42
lines changed

1 file changed

+52
-42
lines changed

‎RemoteConfig.md‎

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Remote config contains configuration that the clients needs to work properly.
44

5-
Corrently the most important value from here is the `clientApiKey` as it is used for every other API
5+
Currently the most important value here is the `clientApiKey` as it is used for every other API
66

77
## Request Method
88
GET
@@ -17,51 +17,61 @@ No
1717

1818
Field | Type | Description
1919
------|------|------------
20-
messageOfTheDay | string | Unknown
21-
timeOutWorldId | string | The ID of the world you get kicked into for timeout
22-
gearDemoRoomId | string | unknown
23-
releaseServerVersionStandalone | string | release server version
20+
messageOfTheDay | string | Unknown (unused)
21+
timeOutWorldId | string | The client goes to this world if banned from public instances
22+
gearDemoRoomId | string | Unknown (unused)
23+
releaseServerVersionStandalone | string | Release server version (unused)
2424
downloadLinkWindows | string | Where you would originally download the game
25-
releaseAppVersionStandalone | string | Game version of release
26-
devAppVersionStandalone | string | Game version of dev
27-
devServerVersionStandalone | string | dev server version
28-
devDownloadLinkWindows | string | the developer download link (Useless)
29-
currentTOSVersion | int | Current TOS version that ues needs to accept
30-
releaseSdkUrl | string | SDK Unitypackage for release
31-
releaseSdkVersion | string | SDK Version for release
32-
devSdkUrl | string | SDK Unitypackage for release
33-
devSdkVersion | string | SDK Version for release
34-
whiteListedAssetUrls | array | from where the client is allowed to download assets
35-
clientApiKey | string | The Key for using the API
36-
viveWindowsUrl | string | Before VRChat had support for vive you would have to download this in order for it too work
37-
sdkUnityVersion | string | Unity version of the SDK
38-
hubWorldId | string | The ID of the hub world
39-
homeWorldId | string | Default Starting World
40-
tutorialWorldId | string | The world for when you first install vrchat / does not matter if new user
41-
disableEventStream | boolean | will the client send a bunch of anonymous data about your device / world / etc
42-
disableAvatarGating | boolean | if set to true everyone can upload avatars, otherwise only users with special permission can
43-
disableFeedbackGating | boolean | if set to true everyone can give feedback, otherwise only users with special permission can
44-
plugin | string | unknown, seems to be comma separeted list of strings
45-
sdkNotAllowedToPublishMessage | string | when you aren't able to upload avatars or worlds on the sdk, this message appears (only on newer sdk)
46-
sdkDeveloperFaqUrl | string | Their faq for the sdk
47-
sdkDiscordUrl | string | their official vrchat discord
48-
notAllowedToSelectAvatarInPrivateWorldMessage | string | when you try to choose avatar from private worlds this message apears
25+
releaseAppVersionStandalone | string | Release game build
26+
devAppVersionStandalone | string | Development game build
27+
devServerVersionStandalone | string | Server version for development build
28+
devDownloadLinkWindows | string | the developer download link (Unused)
29+
currentTOSVersion | int | Current TOS version
30+
releaseSdkUrl | string | Public SDK unitypackage link
31+
releaseSdkVersion | string | Public SDK version
32+
devSdkUrl | string | Development SDK unitypackage link
33+
devSdkVersion | string | Development SDK version
34+
whiteListedAssetUrls | array | Whitelisted download locations for assets
35+
clientApiKey | string | API key used by the client
36+
viveWindowsUrl | string | Before VRChat had support for vive you would have to download this in order for it to work, now redirects to the game's Steam store page
37+
sdkUnityVersion | string | Unity version supported by the SDK
38+
hubWorldId | string | ID of the hub world
39+
homeWorldId | string | ID of the default spawn in world
40+
tutorialWorldId | string | ID of the world used for introduction to the game
41+
disableEventStream | boolean | If true, the client won't send analytics about your current world (not used in client)
42+
disableAvatarGating | boolean | If true, anyone can upload avatars, otherwise, only those with specific tags can (new user and higher)
43+
disableFeedbackGating | boolean | If true, anyone can give feedback, otherwise only users with specific tags can
44+
disableRegistration | bool | If true, registration is disabled
45+
plugin | string | Extra plugins to run on the server, comma-separated strings
46+
sdkNotAllowedToPublishMessage | string | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet
47+
sdkDeveloperFaqUrl | string | Link to the developer FAQ
48+
sdkDiscordUrl | string | Link to the official VRChat Discord
49+
notAllowedToSelectAvatarInPrivateWorldMessage | string | Used in game to notify a user they aren't allowed to select avatars in private worlds
4950
userVerificationTimeout | int | timeout for verification (TODO: what kind of verification), assumed in seconds
5051
userUpdatePeriod | int | timeout between updating, assuming seconds
5152
userVerificationDelay | int | delay between verifications, assuming seconds
52-
userVerificationRetry | int | unknown
53+
userVerificationRetry | int | Delay before the next verification retry
5354
worldUpdatePeriod | int | unknown
5455
moderationQueryPeriod | int | unknown
55-
address | string | Probably VRChat's office address
56-
contactEmail | string | VRChat team's contact email
57-
supportEmail | string | VRChat team's support email
58-
jobsEmail | string | VRChat team's job positions related email
59-
copyrightEmail | string | VRChat team's copyright issues related email
60-
moderationEmail | string | VRChat team's moderation related email
61-
appName | string | App name (VrChat)
62-
serverName | string | the current in use server API
63-
deploymentGroup | string | unknown
64-
buildVersionTag | string | current api version
65-
apiKey | string | The API key, seems to be the same as clientApiKey
56+
defaultAvatar | string | Default avatar ID
57+
dynamicWorldRows | array of `DynamicWorldRows` | Extra rows to display in the client's 'world' listing
58+
address | string | VRChat's office address
59+
contactEmail | string | VRChat's contact email
60+
supportEmail | string | VRChat's support email
61+
jobsEmail | string | VRChat's job application email
62+
copyrightEmail | string | VRChat's copyright issues related email
63+
moderationEmail | string | VRChat's moderation related email
64+
disableEmail | bool | unknown
65+
appName | string | Game name (VrChat)
66+
serverName | string | Currently used photon server plugin version
67+
deploymentGroup | string | Currently used photon server plugin codename
68+
buildVersionTag | string | Build tag for the server plugin
69+
apiKey | string | API key used by the website
6670

67-
[RemoteConfig Live](https://api.vrchat.cloud/api/1/config?apiKey=JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26 ':include :type=iframe width=100% height=400px')
71+
### DynamicWorldRows
72+
73+
Field | Type | Description
74+
------|------|------------
75+
name | string | displayed text in the client
76+
tag | string | any worlds having this tag will appear in the row
77+
index | int | where in the client the row will appear

0 commit comments

Comments
 (0)