VRoid Hub API reference

English

日本語

English

日本語

Appearance

Guidelines for Displaying Model Data Conditions of Use ​

This document provides guidelines on how to display model data conditions of use within applications developed using the VRoid API and SDK.

For the review of VRoid Hub-approved applications, model data conditions of use must be displayed accordingly to these guidelines.Please follow the instructions below when displaying conditions of use obtained from the various APIs.

For Japanese-language applications, please refer to the Japanese version of this document.

Common to VRM 1.0 and 0.0 ​

Title ​

Always use the title "Model Data Conditions of Use".

Differences between VRM 1.0 and VRM 0.0 ​

This section provides an overview of the differences in labeling between VRM 1.0 and VRM 0.0. Please refer to the later sections "For VRM 1.0" and "For VRM 0.0" for detailed specifications.

The comparison between VRM 1.0 and VRM 0.0

Differences in displayed conditions of use ​

In VRM 1.0, the following conditions of use are additionally displayed. These items are not present in VRM 0.0.

  • Usage in religious or political depictions
  • Usage in antisocial or hateful depictions
  • Redistribution of altered models

Differences in handling commercial use ​

While the displayed items are similar, the underlying data structures differ.

  • VRM 1.0: Generates two items ("Corporate Use" and "Commercial Use by Individuals") from a single data source called commercialUsage.

  • VRM 0.0: Generates the same two items from two separate data sources called corporate_commercial_use and personal_commercial_use. In VRM 0.0, "Commercial Use by Individuals" includes the special designation "Non-profit activities only".For details on the distinction between commercial and non-commercial use, see About commercial use on VRoid Hub.

Differences in data source paths ​

  • The API and Unity SDK reference different data source paths for each condition of use.
    • VRM 1.0: The API references CharacterModelSerializer.latest_character_model_version.vrm_meta.*, and the SDK references CharacterModel.latest_character_model_version.vrm_meta.vrm10.*.
    • VRM 0.0: The API references CharacterModelSerializer.license.*, and the SDK references CharacterModel.license.*.

For VRM 1.0 ​

Overall display example ​

An example of how to display conditions of use within an application is shown below.

Model Data Conditions of Use Avatar use: Allow Violent acts: Allow Sexual acts: Allow Political/religious acts: Allow Antisocial/hateful acts: Allow Corporate use: Do not allow Individual commercial use: Do not allow Redistribution: Do not allow Alterations: Do not allow Redistribution of altered model: Do not allow Attribution: Required <button>Download</button> <button>Cancel</button>

Details ​

Usage as Avatar ​

  • Label: Avatar use
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.avatarPermission
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.avatar_permission
  • Display by data value
    • undefined: Not set
    • "everyone": Allow
    • "onlySeparatelyLicensedPerson": Do not allow
    • "onlyAuthor": Do not allow

Usage in Violent Depictions ​

  • Label: Violent acts
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.allowExcessivelyViolentUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.allow_excessively_violent_usage
  • Display by data value
    • undefined: Not set
    • true: Allow
    • false: Do not allow

Usage in Sexual Depictions ​

  • Label: Sexual acts
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.allowExcessivelySexualUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.allow_excessively_sexual_usage
  • Display by data value
    • undefined: Not set
    • true: Allow
    • false: Do not allow

Usage in Religious or Political depictions ​

  • Label: Political/religious acts
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.allowPoliticalOrReligiousUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.allow_political_or_religious_usage
  • Display by data value
    • undefined: Not set
    • true: Allow
    • false: Do not allow

Usage in Antisocial or Hateful Depictions ​

  • Label: Antisocial/hateful acts
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.allowAntisocialOrHateUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.allow_antisocial_or_hate_usage
  • Display by data value
    • undefined: Not set
    • true: Allow
    • false: Do not allow

Corporate Use ​

  • Label: Corporate use
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.commercialUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.commercial_usage
  • Display by data value
    • undefined: Not set
    • "corporation": Allow
    • "personalProfit": Do not allow
    • "personalNonProfit": Do not allow

Individual Commercial Use ​

  • Label: Individual commercial use
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.commercialUsage
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.commercial_usage
  • Display by data value
    • undefined: Not set
    • "corporation": Allow
    • "personalProfit": Allow
    • "personalNonProfit": Do not allow

Redistribution ​

  • Label: Redistribution
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.allowRedistribution
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.allow_redistribution
  • Display by data value
    • undefined: Not set
    • true: Allow
    • false: Do not allow

Alterations ​

  • Label: Alterations
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.modification
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.modification
  • Display by data value
    • undefined: Not set
    • "allowModification": Allow
    • "allowModificationRedistribution": Allow
    • "prohibited": Do not allow

Redistribution of Altered Models ​

  • Label: Redistribution of altered model
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.modification
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.modification
  • Display by data value
    • undefined: Not set
    • "allowModification": Do not allow
    • "allowModificationRedistribution": Allow
    • "prohibited": Do not allow

Attribution ​

  • Label: Attribution
  • Data source
    • API: CharacterModelSerializer.latest_character_model_version.vrm_meta.creditNotation
    • Unity: CharacterModel.latest_character_model_version.vrm_meta.vrm10.credit_notation
  • Display by data value
    • undefined: Not set
    • "required": Required
    • "unnecessary": Not required

For VRM 0.0 ​

Overall display example ​

An example of how to display conditiond of use within an application is shown below.

Model Data Conditions of Use Avatar use: Allow Violent acts: Allow Sexual acts: Allow Corporate use: Do not allow Individual commercial use: Non-profit activities only Redistribution: Do not allow Alterations: Do not allow Attribution: Required <button>Download</button> <button>Cancel</button>

Details ​

Usage as Avatar ​

  • Label: Avatar use
  • Data source
    • API: CharacterModelSerializer.license.characterization_allowed_user
    • Unity: CharacterModel.license.characterization_allowed_user
  • Display by data value
    • "default": Not set
    • "everyone": Allow
    • "author": Do not allow

Usage in Violent Depictions ​

  • Label: Violent acts
  • Data source
    • API: CharacterModelSerializer.license.violent_expression
    • Unity: CharacterModel.license.violent_expression
  • Display by data value
    • "default": Not set
    • "allow": Allow
    • "disallow": Do not allow

Usage in Sexual Depictions ​

  • Label: Sexual acts
  • Data source
    • API: CharacterModelSerializer.license.sexual_expression
    • Unity: CharacterModel.license.sexual_expression
  • Display by data value
    • "default": Not set
    • "allow": Allow
    • "disallow": Do not allow

Corporate Use ​

  • Label: Corporate use
  • Data source
    • API: CharacterModelSerializer.license.corporate_commercial_use
    • Unity: CharacterModel.license.corporate_commercial_use
  • Display by data value
    • "default": Not set
    • "allow": Allow
    • "disallow": Do not allow

Individual Commercial Use ​

  • Label: Individual commercial use
  • Data source
    • API: CharacterModelSerializer.license.personal_commercial_use
    • Unity: CharacterModel.license.personal_commercial_use
  • Display by data value
    • "default": Not set
    • "profit": Allow
    • "nonprofit": Non-profit activities only
    • "disallow": Do not allow

Redistribution ​

  • Label: Redistribution
  • Data source
    • API: CharacterModelSerializer.license.redistribution
    • Unity: CharacterModel.license.redistribution
  • Display by data value
    • "default": Not set
    • "allow": Allow
    • "disallow": Do not allow

Alterations ​

  • Label: Alterations
  • Data source
    • API: CharacterModelSerializer.license.modification
    • Unity: CharacterModel.license.modification
  • Display by data value
    • "default": Not set
    • "allow": Allow
    • "disallow": Do not allow

Credits ​

  • Label: Attribution
  • Data source
    • API: CharacterModelSerializer.license.credit
    • Unity: CharacterModel.license.credit
  • Display by data value
    • "default": Not set
    • "necessary": Required
    • "unnecessary": Not required

Overwriting license data ​

VRM 0.0 files uploaded to VRoid Hub retain their original license data. However, when the "Allow third-party usage" option is enabled, the content is changed and overwritten based on VRoid Hub's conditions of use.

The "Other License URL" will also be changed and overwritten by VRoid Hub's license URL.

Copyright © pixiv