SubmittingModels.md

Submitting New Models

We appreciate sample model contributions; they help ensure a consistent glTF ecosystem.

To contribute a model, open a pull request with:

• A new subdirectory containing
  • The model in as many glTF variations as reasonable (using the same directory structure as the others (example)). Tools for converting to glTF are here.
  • A screenshot of the model, stored in a subdirectory called /screenshot
  • A metadata JSON file containing various information about the model. The file must be in the new subdirectory with the name metadata.json. It will be automatically upgrade if need be. See Example Metadata File (below) for details
  • A optional README.md with information about the model. As shown in this example. The metadata determines if this file is automatically generated. It is best if you create one with more information than can be auto-generated. When provided this file should at least include the following elements:
    • The name or title of the model
    • An embedding of the screenshot
    • Information about the license under which the model is published. It is best to format it according to the auto-format rules (see below). Khronos recommends use of a permissive license like Creative Commons Attribution 4.0 International License or even Creative Commons 1.0 Universal Public Domain Dedication , to allow people to share and adapt the models for their own use.
• The model will be listed in all displays based on the tags in the metadata.

If you have any questions, submit an issue.

Example Metadata File

The metadata file is always called metadata.json and is located in the model root directory (not the root directory of the repo). It specifies the necessary metadata of the model including its name, ownership, artist, license, and tags. The current version of the JSON structure is below. If you are unsure of the details, set the version number to less than the current and the system will automatically upgrade the file.

{
    "version" : 2,
    "legal" : [
        {
            "artist" : "",
            "owner" : "",
            "year" : "",
            "license" : "",
            "what" : ""
        }
      ],
    "tags" : [],
    "screenshot" : "screenshot/screenshot.jpg",
    "name" : "",
    "path" : "",
    "summary" : "",
    "createReadme" : false
}

The legal structure contains information about each owner of the model. It comprises of the following elements:

• what: What was done to get the model to this stage. Standard terminology includes Everything or Creation for the initial work; Mesh for the geometry; Texture for all materrials; Animation for movement; and Conversion for converting to glTF.

• artist: The name of the artist(s) who performed the what.

• owner: The owner of the model for this operation. This is may be the artist or the organization responsible for the artist. If the work is in the Public Domain, then the owner may be Public.

• year: The year the work was performed.

• license: The licensed assigned by the owner. Standard license shorthand should be used. The known shorthand is

  • CCO
  • PD
  • CC-BY / CC-BY International 4.0
  • CC-BY-ND
  • CC-BY-NC
  • CC-BY-NC-ND
  • others?

License & Credit Format

The system can automatically generate a license and credit block in the format below. If you manually generate a README file, then please try to follow this format as much as possible. This item is repeated as many times as necessary. Put the oldest item first.

© <year>, <owner>. <license name> (with optional link to legal text)
 - <artist> for <what>