How to build a metadata.yml file

Intro

The .metadata.yml file replaces the manual changes that were previously required to the top level README.md. Instead of modifying this file, you must now create one .metadata.yml file per mod, and include it in your PR.

Format

Please find the format of the metadata file with some examples below

---
# The title of your mod. Choose a short and descriptive name
title: My awesome mod
# A short description of your mod. Try to describe your mod with 1-2 short sentences
description: This mod makes VoronDesign printers more awesome!
# Mod version: Set this to 1 when you are submitting a new mod. When you make changes to your mod, you may increment this number
mod_version: 1
# You may add your discord username here so people can contact you about your mod
discord_username: Haribro
# The CAD files for your mod. Please provide them as a list.
# Note that each mod must include at least one CAD file.
cad:
- STEP/CAD_FILE_1.step
- STEP/CAD_FILE_1.f360
# The parts of your mod, exported and oriented ready to be sliced. Please provide them as a list.
# Note that each mod must include at least one STL or OBJ file.
stl:
- STLs/STL_FILE_1.stl
- STLs/STL_FILE_2.obj
# The image files provided with your mod. These may be instructions you use in your README.md file, or other additional pictures.
# **Note that the first image specified here will be used as cover image on mods.vorondesign.com**
# All paths are relative to this .metadata.yml file.
images:
- images/IMAGE_1.png
- images/IMAGE_2.png
- images/IMAGE_3.png
# Printer compatibility. Please specify all compatible printers as a list. The following values are accepted:
# "V0", "V0.1", "V0.2", "V0.2r1", "V1", "V1.6", "V1.8", "V1.8r1",  "V2", "V2.1", "V2.2", "V2.4", "V2.4r1", "V2.4r2", "VSW", "VT", "VTr1", "VL"
# Please only specify printers that you have either tested your mod on yourself, or that someone else has tested for you. If you are unsure whether your
# mod is compatible with a certain printer, don't list it here!
printer_compatibility:
- V1.8
- VT
- V2.4r2