|
1 | | -# Config |
| 1 | +# APIConfig |
2 | 2 |
|
3 | 3 |
|
4 | 4 | ## Properties |
5 | 5 | Name | Type | Description | Notes |
6 | 6 | ------------ | ------------- | ------------- | ------------- |
7 | | -**address** | **str** | VRChat's office address | [readonly] |
8 | | -**announcements** | [**[ConfigAnnouncements]**](ConfigAnnouncements.md) | Public Announcements | [readonly] |
9 | | -**api_key** | **str** | apiKey to be used for all other requests | [readonly] |
10 | | -**build_version_tag** | **str** | Build tag of the API server | [readonly] |
11 | | -**client_api_key** | **str** | apiKey to be used for all other requests | [readonly] |
12 | | -**contact_email** | **str** | VRChat's contact email | [readonly] |
13 | | -**copyright_email** | **str** | VRChat's copyright-issues-related email | [readonly] |
14 | | -**current_tos_version** | **float** | Current version number of the Terms of Service | [readonly] |
| 7 | +**address** | **str** | VRChat's office address | |
| 8 | +**announcements** | [**[PublicAnnouncement]**](PublicAnnouncement.md) | Public Announcements | |
| 9 | +**api_key** | **str** | apiKey to be used for all other requests | |
| 10 | +**build_version_tag** | **str** | Build tag of the API server | |
| 11 | +**client_api_key** | **str** | apiKey to be used for all other requests | |
| 12 | +**contact_email** | **str** | VRChat's contact email | |
| 13 | +**copyright_email** | **str** | VRChat's copyright-issues-related email | |
| 14 | +**current_tos_version** | **int** | Current version number of the Terms of Service | |
15 | 15 | **default_avatar** | [**AvatarID**](AvatarID.md) | | |
16 | 16 | **deployment_group** | [**DeploymentGroup**](DeploymentGroup.md) | | |
17 | | -**dev_app_version_standalone** | **str** | Version number for game development build | [readonly] |
18 | | -**dev_download_link_windows** | **str** | Developer Download link | [readonly] |
19 | | -**dev_sdk_url** | **str** | Link to download the development SDK, use downloadUrls instead | [readonly] |
20 | | -**dev_sdk_version** | **str** | Version of the development SDK | [readonly] |
21 | | -**dev_server_version_standalone** | **str** | Version number for server development build | [readonly] |
22 | | -**download_link_windows** | **str** | Download link for game on the Oculus Rift website. | [readonly] |
23 | | -**download_urls** | [**ConfigDownloadUrls**](ConfigDownloadUrls.md) | | |
24 | | -**dynamic_world_rows** | [**[ConfigDynamicWorldRows]**](ConfigDynamicWorldRows.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | [readonly] |
25 | | -**events** | [**ConfigEvents**](ConfigEvents.md) | | |
26 | | -**gear_demo_room_id** | **str** | Unknown | [readonly] |
| 17 | +**dev_app_version_standalone** | **str** | Version number for game development build | |
| 18 | +**dev_download_link_windows** | **str** | Developer Download link | |
| 19 | +**dev_sdk_url** | **str** | Link to download the development SDK, use downloadUrls instead | |
| 20 | +**dev_sdk_version** | **str** | Version of the development SDK | |
| 21 | +**dev_server_version_standalone** | **str** | Version number for server development build | |
| 22 | +**dis_countdown** | **datetime** | Unknown, \"dis\" maybe for disconnect? | |
| 23 | +**download_link_windows** | **str** | Download link for game on the Oculus Rift website. | |
| 24 | +**download_urls** | [**DownloadURLList**](DownloadURLList.md) | | |
| 25 | +**dynamic_world_rows** | [**[DynamicWorldRow]**](DynamicWorldRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | |
| 26 | +**events** | [**APIEventConfig**](APIEventConfig.md) | | |
| 27 | +**gear_demo_room_id** | **str** | Unknown | |
27 | 28 | **home_world_id** | [**WorldID**](WorldID.md) | | |
28 | 29 | **hub_world_id** | [**WorldID**](WorldID.md) | | |
29 | | -**jobs_email** | **str** | VRChat's job application email | [readonly] |
30 | | -**message_of_the_day** | **str** | MOTD | [readonly] |
31 | | -**moderation_email** | **str** | VRChat's moderation related email | [readonly] |
32 | | -**moderation_query_period** | **float** | Unknown | |
33 | | -**not_allowed_to_select_avatar_in_private_world_message** | **str** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | [readonly] |
34 | | -**plugin** | **str** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | [readonly] |
35 | | -**release_app_version_standalone** | **str** | Version number for game release build | [readonly] |
36 | | -**release_sdk_url** | **str** | Link to download the release SDK | [readonly] |
37 | | -**release_sdk_version** | **str** | Version of the release SDK | [readonly] |
38 | | -**release_server_version_standalone** | **str** | Version number for server release build | [readonly] |
39 | | -**sdk_developer_faq_url** | **str** | Link to the developer FAQ | [readonly] |
40 | | -**sdk_discord_url** | **str** | Link to the official VRChat Discord | [readonly] |
41 | | -**sdk_not_allowed_to_publish_message** | **str** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | [readonly] |
42 | | -**sdk_unity_version** | **str** | Unity version supported by the SDK | [readonly] |
43 | | -**server_name** | **str** | Server name of the API server currently responding | [readonly] |
44 | | -**support_email** | **str** | VRChat's support email | [readonly] |
| 30 | +**jobs_email** | **str** | VRChat's job application email | |
| 31 | +**message_of_the_day** | **str** | MOTD | |
| 32 | +**moderation_email** | **str** | VRChat's moderation related email | |
| 33 | +**moderation_query_period** | **int** | Unknown | |
| 34 | +**not_allowed_to_select_avatar_in_private_world_message** | **str** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | |
| 35 | +**plugin** | **str** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | |
| 36 | +**release_app_version_standalone** | **str** | Version number for game release build | |
| 37 | +**release_sdk_url** | **str** | Link to download the release SDK | |
| 38 | +**release_sdk_version** | **str** | Version of the release SDK | |
| 39 | +**release_server_version_standalone** | **str** | Version number for server release build | |
| 40 | +**sdk_developer_faq_url** | **str** | Link to the developer FAQ | |
| 41 | +**sdk_discord_url** | **str** | Link to the official VRChat Discord | |
| 42 | +**sdk_not_allowed_to_publish_message** | **str** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | |
| 43 | +**sdk_unity_version** | **str** | Unity version supported by the SDK | |
| 44 | +**server_name** | **str** | Server name of the API server currently responding | |
| 45 | +**support_email** | **str** | VRChat's support email | |
45 | 46 | **time_out_world_id** | [**WorldID**](WorldID.md) | | |
46 | 47 | **tutorial_world_id** | [**WorldID**](WorldID.md) | | |
47 | | -**update_rate_ms_maximum** | **float** | Unknown | [readonly] |
48 | | -**update_rate_ms_minimum** | **float** | Unknown | [readonly] |
49 | | -**update_rate_ms_normal** | **float** | Unknown | [readonly] |
50 | | -**update_rate_ms_udon_manual** | **float** | Unknown | [readonly] |
51 | | -**upload_analysis_percent** | **float** | Unknown | [readonly] |
52 | | -**url_list** | **[str]** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | [readonly] |
53 | | -**user_update_period** | **float** | Unknown | [readonly] |
54 | | -**user_verification_delay** | **float** | Unknown | [readonly] |
55 | | -**user_verification_retry** | **float** | Unknown | [readonly] |
56 | | -**user_verification_timeout** | **float** | Unknown | [readonly] |
57 | | -**vive_windows_url** | **str** | Download link for game on the Steam website. | [readonly] |
58 | | -**white_listed_asset_urls** | **[str]** | List of allowed URLs that are allowed to host avatar assets | [readonly] |
59 | | -**world_update_period** | **float** | Unknown | [readonly] |
60 | | -**youtubedl_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format | [readonly] |
61 | | -**youtubedl_version** | **str** | Currently used youtube-dl.exe version | [readonly] |
62 | | -**app_name** | **str** | Game name | [readonly] defaults to "VrChat" |
| 48 | +**update_rate_ms_maximum** | **int** | Unknown | |
| 49 | +**update_rate_ms_minimum** | **int** | Unknown | |
| 50 | +**update_rate_ms_normal** | **int** | Unknown | |
| 51 | +**update_rate_ms_udon_manual** | **int** | Unknown | |
| 52 | +**upload_analysis_percent** | **int** | Unknown | |
| 53 | +**url_list** | **[str]** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | |
| 54 | +**user_update_period** | **int** | Unknown | |
| 55 | +**user_verification_delay** | **int** | Unknown | |
| 56 | +**user_verification_retry** | **int** | Unknown | |
| 57 | +**user_verification_timeout** | **int** | Unknown | |
| 58 | +**vive_windows_url** | **str** | Download link for game on the Steam website. | |
| 59 | +**white_listed_asset_urls** | **[str]** | List of allowed URLs that are allowed to host avatar assets | |
| 60 | +**world_update_period** | **int** | Unknown | |
| 61 | +**youtubedl_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format | |
| 62 | +**youtubedl_version** | **str** | Currently used youtube-dl.exe version | |
| 63 | +**voice_enable_degradation** | **bool** | Unknown, probably voice optimization testing | defaults to False |
| 64 | +**voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | defaults to True |
| 65 | +**app_name** | **str** | Game name | defaults to "VrChat" |
| 66 | +**client_bps_ceiling** | **int** | Unknown | defaults to 18432 |
| 67 | +**client_disconnect_timeout** | **int** | Unknown | defaults to 30000 |
| 68 | +**client_reserved_player_bps** | **int** | Unknown | defaults to 7168 |
| 69 | +**client_sent_count_allowance** | **int** | Unknown | defaults to 15 |
63 | 70 | **disable_avatar_copying** | **bool** | Toggles if copying avatars should be disabled | defaults to False |
64 | 71 | **disable_avatar_gating** | **bool** | 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 | defaults to False |
65 | 72 | **disable_community_labs** | **bool** | Toggles if the Community Labs should be disabled | defaults to False |
66 | 73 | **disable_community_labs_promotion** | **bool** | Toggles if promotion out of Community Labs should be disabled | defaults to False |
67 | | -**disable_event_stream** | **bool** | Toggles if Analytics should be disabled (this sreportedly not used in the Client) | defaults to False |
| 74 | +**disable_email** | **bool** | Unknown | defaults to False |
| 75 | +**disable_event_stream** | **bool** | Toggles if Analytics should be disabled. | defaults to False |
68 | 76 | **disable_feedback_gating** | **bool** | 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. | defaults to False |
69 | | -**disable_registration** | **bool** | Toggles if new user account registration should be disabled | defaults to False |
| 77 | +**disable_frontend_builds** | **bool** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | defaults to False |
| 78 | +**disable_hello** | **bool** | Unknown | defaults to False |
| 79 | +**disable_oculus_subs** | **bool** | Toggles if signing up for Subscriptions in Oculus is disabled or not. | defaults to False |
| 80 | +**disable_registration** | **bool** | Toggles if new user account registration should be disabled. | defaults to False |
70 | 81 | **disable_steam_networking** | **bool** | Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead. | defaults to True |
71 | 82 | **disable_two_factor_auth** | **bool** | Toggles if 2FA should be disabled. | defaults to False |
72 | 83 | **disable_udon** | **bool** | Toggles if Udon should be universally disabled in-game. | defaults to False |
73 | 84 | **disable_upgrade_account** | **bool** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | defaults to False |
74 | | -**homepage_redirect_target** | **str** | Redirect target if you try to open the base API domain in your browser | [readonly] defaults to "https://hello.vrchat.com" |
| 85 | +**homepage_redirect_target** | **str** | Redirect target if you try to open the base API domain in your browser | defaults to "https://hello.vrchat.com" |
75 | 86 | **use_reliable_udp_for_voice** | **bool** | Unknown | defaults to False |
76 | | -**client_bps_ceiling** | **float** | Unknown | [optional] |
77 | | -**client_disconnect_timeout** | **float** | Unknown | [optional] |
78 | | -**client_reserved_player_bps** | **float** | Unknown | [optional] |
79 | | -**client_sent_count_allowance** | **float** | Unknown | [optional] |
80 | | -**disable_email** | **bool** | Unknown | [optional] if omitted the server will use the default value of False |
81 | | -**disable_hello** | **bool** | Unknown | [optional] if omitted the server will use the default value of False |
82 | 87 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] |
83 | 88 |
|
84 | 89 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
|
0 commit comments