# Save as .oic/project.yaml. Supported v2 profile; all paths are relative to this file.
# Fictional project, publisher, files and URLs; replace with real authorized content.
schema: oic/project/v2
id: example-process-viewer
name: Example Process Viewer
summary: Explore a process diagram and inspect simulated equipment readings.
category: Visualization
tags: [Process visualization, Simulation]
platforms: [Web browser]
publisher:
  name: Example Tools Collective
  url: https://example.org

description:
  text: >-
    A free browser viewer for learning how a process fits together.
    Explore the sample diagram, select equipment, and inspect synthetic readings.
  # Alternatively: file: ./overview.md (text and file are mutually exclusive)

source:
  availability: closed-source
  # Public listing-repo location is registered by OIC, not a source-code claim.
license:
  name: Example free browser preview terms
  url: https://example.org/terms
  # spdx_expression: MIT  # only when those are the actual software terms
access:
  edition: Browser preview
  cost: free
  account_required: false
  notes: Free for evaluation and learning, without an account or time limit. Synthetic data only.
requirements: [] # Explicitly no additional dependencies for this listed browser preview.
# Example requirement for another tool:
# - name: Required host platform
#   kind: software
#   cost: paid
#   version: ">=8.1"
#   applies_to: [install]
#   notes: The listed extension is free; its host platform requires a separate license.
#   url: https://example.org/host

actions:
  - id: demo
    type: demo
    url: https://example.org/demo
    primary: true
# Optional files and resources. Link to locations you control; OIC does not host the payload.
# A resource without its own license uses the project license above.
# Uncomment and replace only the resources you actually offer.
# resources:
#   - id: source
#     kind: source
#     title: Source repository
#     url: https://github.com/example/project
#     access: public
#     license:
#       name: Apache-2.0
#       url: https://github.com/example/project/blob/main/LICENSE
#   - id: ignition-module
#     kind: download
#     title: Ignition module
#     format: .modl
#     version: "1.0.0"
#     url: https://github.com/example/project/releases/download/v1.0.0/project.modl
#     access: public
#     setup: Requires a separately licensed Ignition Gateway.
#     sha256: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
#   - id: container
#     kind: container
#     title: Container image
#     url: https://github.com/example/project/pkgs/container/project
#     image: ghcr.io/example/project:1.0.0
#     access: public
#   - id: install-guide
#     kind: document
#     title: Installation guide
#     format: PDF
#     url: https://example.org/docs/install.pdf
#     access: public
links:
  docs: https://example.org/docs
  wiki: https://example.org/wiki
  issues: https://example.org/issues
  discussions: https://example.org/community
  changelog: https://example.org/releases
  support: https://example.org/support

branding:
  logo:
    on_light: ./media/logo-on-light.png
    on_dark: ./media/logo-on-dark.png
    alt: Example Process Viewer
media:
  - id: process
    type: image
    src: ./media/overview.webp
    alt: Process diagram showing a tank, pump and heat exchanger with simulated readings.
    caption: Sample scene with synthetic data; no plant connection.
    credit: Example Tools Collective
  - id: setup
    type: image
    src: ./media/setup.webp
    alt: Setup screen with a local sample scene selected.
    caption: Choose a sample scene to begin.
  # A short GIF is also type: image. OIC creates an animated WebP and a still preview.
  # - id: quick-tour
  #   type: image
  #   src: ./media/quick-tour.gif
  #   alt: Cursor opening a sample process diagram and selecting a pump.
  #   title: One-minute workflow
  #   caption: Synthetic sample data; animation plays only when selected.
  - id: walkthrough
    type: video
    url: https://example.org/videos/walkthrough
    poster: ./media/walkthrough-poster.webp
    title: A short tour of the viewer
    transcript: https://example.org/videos/walkthrough-transcript

faq:
  - question: Does this connect to my plant?
    answer: No. This listed preview uses synthetic data only.
  - question: Do I need an account?
    answer: No. Open the browser preview to try the included scene.
lifecycle:
  stage: preview
  maintenance: active
release:
  version: "0.1.0"
  url: https://example.org/releases/0.1.0
  date: "2026-09-28"
visibility: listed
# Optional discovery metadata. Add only facts supported by the listed edition.
# discovery:
#   primary: visualization
#   product_type: application
#   # Choose application, tool, demo, extension, resource, library, or assets.
#   # An Ignition module is an extension delivered as a module in options[].
#   capabilities: [Symbol generation, SVG export]
#   works_with:
#     - name: Ignition Perspective
#       relationship: exports
#   options:
#     - delivery: web
#       environments: [Browser]
#       deployment: [hosted]
#   offline: unknown
#   air_gap: unknown
#   commercial_use: unknown
# Package-specific options can name resource_id from resources[].
# air_gap: documented also requires an air_gap_url reference.