screenkit 0.0.1 → 0.0.3

data/lib/screenkit/generators/episode/config.yml.erb

@@ -1,5 +1,5 @@
 ---
-# yaml-language-server: $schema=../../../screenkit/lib/screenkit/schemas/episode.json
+# yaml-language-server: $schema=https://screenkit.dev/schemas/episode.json
 
 # The episode title. When there are no linebreaks, they will be inferred based
 # on the approximate text width.
@@ -10,7 +10,7 @@ title: "CREATING SCREENCASTS WITH SCREENKIT"
 #
 # The project's configuration can define the callout structure, while the
 # episode configuration can define the content and timing.
-callouts:
+callouts_styles:
   - type: info
     title: "ScreenKit"
     body: "Visit https://github.com/fnando/screenkit to learn more."
@@ -45,7 +45,7 @@ callouts:
 #     title:
 #       x: 100
 #       y: 300
-#       font_path: lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-ExtraBold.ttf
+#       font_path: open-sans/OpenSans-ExtraBold.ttf
 #       size: 144
 #       color: "#ffffff"
 #
@@ -53,7 +53,7 @@ callouts:
 #     # Works best with a transparent PNG file in high resolution (at least 2x the
 #     # size it'll be displayed).
 #     logo:
-#       path: lib/screenkit/generators/project/resources/images/logo.png
+#       path: images/logo.png
 #       x: 100
 #       y: 200
 #       width: 200
@@ -62,7 +62,7 @@ callouts:
 #     # The sound to be played along with the logo in the intro.
 #     # This must correspond to a sound file in the sounds directory, with any
 #     # audio extension (e.g. mp3, m4a, wav).
-#     sound: lib/screenkit/generators/project/resources/sounds/chime.mp3
+#     sound: sounds/chime.mp3
 #
 #   outro:
 #     # The duration of the outro scene in seconds.
@@ -78,11 +78,11 @@ callouts:
 #     background: "#100f50"
 #
 #     # The sound to be played along with the logo in the outro.
-#     sound: lib/screenkit/generators/project/resources/sounds/chime.mp3
+#     sound: sounds/chime.mp3
 #
 #     # The logo to be displayed in the video outro.
 #     logo:
-#       path: lib/screenkit/generators/project/resources/images/logo.png
+#       path: images/logo.png
 #       x: center
 #       y: center
 #       width: 500
@@ -95,7 +95,7 @@ callouts:
 # When present, this will have higher precedence over the project's
 # configuration, so you can have different intro/outro segments for each
 # episode.
-# voice:
+# tts:
 #   engine: elevenlabs
 #   voice_id: 56AoDkrOh6qfVPDXZ7Pt
 #   language_code: en

data/lib/screenkit/generators/project/screenkit.yml

@@ -1,5 +1,6 @@
 ---
 # yaml-language-server: $schema=../../schemas/project.json
+## yaml-language-server: $schema=https://screenkit.dev/schemas/project.json
 
 # ScreenKit project configuration file.
 schema: 1
@@ -76,19 +77,35 @@ watermark:
   margin: 100
 
 # TTS configuration.
-# To disable voiceover entirely, set `tts: false`.
-# tts:
-#   engine: elevenlabs
-#   voice_id: 56AoDkrOh6qfVPDXZ7Pt
-#   language_code: en
-#   voice_settings:
-#     speed: 0.9
-#     stability: 0.5
-#     similarity: 0.75
-#     style: 0.0
+# To disable voiceover entirely, set `tts: false` or disable all engines
+# individually.
+#
+# You can set up multiple TTS engines to be used as fallbacks in case one fails.
+# Each TTS engine has its own detection mechanism. For instance, say and espeak
+# checks for a binary with the same name. ElevenLabs checks for the presence of
+# `--tts-api-key`.
 tts:
-  engine: say
-  rate: 150
+  # Apple Say TTS engine configuration.
+  - engine: say
+    rate: 150
+    enabled: true
+
+  # eSpeak TTS engine configuration.
+  - engine: espeak
+    rate: 150
+    voice: en-us
+    enabled: true
+
+  # Eleven Labs TTS engine configuration.
+  - engine: eleven_labs
+    enabled: true
+    voice_id: 56AoDkrOh6qfVPDXZ7Pt
+    language_code: en
+    voice_settings:
+      speed: 0.9
+      stability: 0.5
+      similarity: 0.75
+      style: 0.0
 
 # Scene configurations define how different scenes in the video are rendered.
 # There are three types of scenes: intro, outro, and segment.
@@ -227,9 +244,10 @@ demotape:
 # in the video. Callouts are visual elements that highlight important
 # information. Each callout type can have its own settings for icon, background,
 # text styles, animations, and sounds.
-callouts:
-  info:
-    # yaml-language-server: $schema=../../schemas/callouts/default.json
+callout_styles:
+  shadow_block:
+    # yaml-language-server: $schema=https://screenkit.dev/schemas/callout_styles/default.json
+    style: shadow_block
     background_color: "#ffff00"
     shadow: "#2242d3"
     title_style:
@@ -252,3 +270,16 @@ callouts:
       sound:
         path: pop.mp3
         volume: 0.7
+
+  inline_block:
+    # yaml-language-server: $schema=https://screenkit.dev/schemas/callout_styles/inline_block.json
+    style: inline_block
+    anchor: [left, bottom]
+    margin: 100
+    animation: fade
+    in_transition:
+      duration: 0.4s
+      sound: pop.mp3
+    out_transition:
+      duration: 0.4s
+      sound: pop.mp3

data/lib/screenkit/schema_validator.rb

@@ -6,7 +6,7 @@ module ScreenKit
       errors = JSON::Validator
                .fully_validate("file://#{schema_path}", attributes)
 
-      return if errors.empty?
+      return true if errors.empty?
 
       raise ArgumentError, "Invalid attributes: #{errors.first}"
     end

data/lib/screenkit/schemas/callout_styles/file_copy.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://screenkit.dev/schemas/callout_styles/file_copy.json",
+  "title": "File Copy Callout",
+  "type": "object",
+  "required": ["file_path"],
+  "properties": { "file_path": { "type": "string", "format": "uri" } }
+}

data/lib/screenkit/schemas/callout_styles/inline_block.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://screenkit.dev/schemas/callout_styles/inline_block.json",
+  "title": "Inline Block Callout",
+  "type": "object",
+  "required": ["background_color", "text_style"],
+  "properties": {
+    "background_color": { "$ref": "../refs/color.json" },
+    "width": {
+      "type": "number",
+      "description": "The callout width"
+    },
+    "text_style": {
+      "$ref": "../refs/text_style.json"
+    },
+    "padding": {
+      "$ref": "../refs/spacing.json"
+    }
+  }
+}

data/lib/screenkit/schemas/{callouts/default.json → callout_styles/shadow_block.json}

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/callouts/basic.json",
-  "title": "Basic Callout",
+  "$id": "https://screenkit.dev/schemas/callout_styles/shadow_block.json",
+  "title": "Shadow Block Callout",
   "type": "object",
   "required": [
     "background_color",

data/lib/screenkit/schemas/callouts/inline_block.json

@@ -1,20 +1,29 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/callouts/inline_block.json",
-  "title": "Inline Block Callout",
+  "$id": "https://screenkit.dev/schemas/callouts/inline_block.json",
+  "title": "Callout — Inline Block",
   "type": "object",
-  "required": ["background_color", "text_style"],
+  "required": ["type", "text", "duration", "starts_at"],
   "properties": {
-    "background_color": { "$ref": "../refs/color.json" },
-    "width": {
-      "type": "number",
-      "description": "The callout width"
+    "type": {
+      "type": "string",
+      "enum": ["inline_block"],
+      "description": "The callout type"
     },
-    "text_style": {
-      "$ref": "../refs/text_style.json"
+    "text": {
+      "type": "string",
+      "description": "The callout text"
     },
-    "padding": {
-      "$ref": "../refs/spacing.json"
+    "duration": { "$ref": "../refs/duration.json" },
+    "starts_at": {
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^(\\d{1,2}:)?(\\d{1,2}):(\\d{1,2})$",
+          "description": "A pattern like 00:00:00"
+        },
+        { "type": "integer", "description": "The position in seconds" }
+      ]
     }
   }
 }

data/lib/screenkit/schemas/callouts/shadow_block.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://screenkit.dev/schemas/callouts/shadow_block.json",
+  "title": "Callout — Shadow Block",
+  "type": "object",
+  "required": ["type", "duration", "starts_at"],
+  "anyOf": [{ "required": ["title"] }, { "required": ["body"] }],
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["shadow_block"],
+      "description": "The callout type"
+    },
+    "title": {
+      "type": "string",
+      "description": "The callout text"
+    },
+    "body": {
+      "type": "string",
+      "description": "The callout body text"
+    },
+    "width": {
+      "type": "number",
+      "description": "The callout width",
+      "minimum": 0
+    },
+    "duration": { "$ref": "../refs/duration.json" },
+    "starts_at": {
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^\\d{2}:\\d{2}:\\d{2}$",
+          "description": "A pattern like 00:00:00"
+        },
+        { "type": "integer", "description": "The position in seconds" }
+      ]
+    }
+  }
+}

data/lib/screenkit/schemas/episode.json

@@ -1,8 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/episode.json",
-  "title": "ScreenKit Episode Configuration",
-  "description": "Schema for ScreenKit episode configuration file (config.yml)",
+  "$id": "https://screenkit.dev/schemas/episode.json",
+  "title": "ScreenKit Episode Configuration (config.yml)",
   "type": "object",
   "required": ["title"],
   "properties": {
@@ -17,46 +16,10 @@
       "pattern": "\\S"
     },
     "demotape": { "$ref": "refs/demotape.json" },
-    "callouts": {
-      "type": "array",
-      "description": "List of callouts to be used in the episode",
-      "items": {
-        "type": "object",
-        "required": ["type", "starts_at", "duration"],
-        "additionalProperties": true,
-        "properties": {
-          "type": {
-            "type": "string",
-            "description": "Callout type identifier",
-            "minLength": 1,
-            "pattern": "\\S"
-          },
-          "starts_at": {
-            "oneOf": [
-              {
-                "type": "string",
-                "description": "Callout start time in HH:MM:SS format (e.g. 00:01:30)"
-              },
-              {
-                "type": "number",
-                "description": "Callout start time in seconds (e.g. 90)"
-              }
-            ]
-          },
-          "duration": { "$ref": "refs/duration.json" },
-          "width": {
-            "oneOf": [
-              {
-                "type": "string",
-                "description": "Callout width in percentage (e.g. 50%)"
-              },
-              {
-                "type": "number",
-                "description": "Callout width in pixels (e.g. 300)"
-              }
-            ]
-          }
-        }
+    "callout_styles": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "refs/callout_style.json"
       }
     }
   }

data/lib/screenkit/schemas/project.json

@@ -1,8 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
-  "title": "ScreenKit Project Configuration",
-  "description": "Schema for ScreenKit project configuration file (screenkit.yml)",
+  "$id": "https://screenkit.dev/schemas/project.json",
+  "title": "ScreenKit Project Configuration (screenkit.yml)",
   "type": "object",
   "required": ["schema", "resources_dir", "episode_dir", "output_dir"],
   "properties": {
@@ -26,10 +25,10 @@
       "description": "Directory where generated video files will be saved. Supports placeholders like %{episode_number}, %{episode_slug} and %{date}.",
       "format": "uri"
     },
-    "callouts": {
+    "callout_styles": {
       "type": "object",
       "additionalProperties": {
-        "$ref": "refs/callout.json"
+        "$ref": "refs/callout_style.json"
       }
     },
     "demotape": { "$ref": "refs/demotape.json" }

data/lib/screenkit/schemas/refs/anchor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/anchor.json",
+  "$id": "https://screenkit.dev/schemas/refs/anchor.json",
   "title": "Anchor",
   "type": "array",
   "description": "Anchor position [horizontal, vertical]",

data/lib/screenkit/schemas/refs/animation.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/animation.json",
+  "$id": "https://screenkit.dev/schemas/refs/animation.json",
   "title": "Animation Type",
   "type": "string",
   "enum": ["slide", "fade"]

data/lib/screenkit/schemas/refs/background.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/background.json",
+  "$id": "https://screenkit.dev/schemas/refs/background.json",
   "title": "Background",
   "anyOf": [
     {

data/lib/screenkit/schemas/refs/{callout.json → callout_style.json}

@@ -1,14 +1,15 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/callout.json",
-  "title": "Callout",
+  "$id": "https://screenkit.dev/schemas/refs/callout_style.json",
+  "title": "Callout Style",
   "type": "object",
   "required": [
     "in_transition",
     "out_transition",
     "anchor",
     "margin",
-    "animation"
+    "animation",
+    "style"
   ],
   "properties": {
     "in_transition": { "$ref": "transition.json" },
@@ -17,11 +18,8 @@
     "margin": { "$ref": "spacing.json" },
     "style": {
       "type": "string",
-      "description": "Callout style name (defaults to 'default')",
-      "default": "default"
+      "description": "Callout style name"
     },
-    "anchor": {
-      "$ref": "anchor.json"
-    }
+    "anchor": { "$ref": "anchor.json" }
   }
 }

data/lib/screenkit/schemas/refs/color.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/color.json",
+  "$id": "https://screenkit.dev/schemas/refs/color.json",
   "title": "Color type with optional alpha channel",
   "type": "string",
   "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$"

data/lib/screenkit/schemas/refs/demotape.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/demotape.json",
+  "$id": "https://screenkit.dev/schemas/refs/demotape.json",
   "title": "Demo Tape settings (https://github.com/fnando/demotape)",
   "type": "object",
   "properties": {

data/lib/screenkit/schemas/refs/demotape_themes.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/demotape_themes.json",
+  "$id": "https://screenkit.dev/schemas/refs/demotape_themes.json",
   "title": "Demo Tape themes",
   "type": "string",
   "enum": [

data/lib/screenkit/schemas/refs/directory.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
+  "$id": "https://screenkit.dev/schemas/refs/project.json",
   "title": "Directory",
   "oneOf": [
     {

data/lib/screenkit/schemas/refs/duration.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/duration.json",
+  "$id": "https://screenkit.dev/schemas/refs/duration.json",
   "title": "Duration",
   "oneOf": [
     { "type": "string", "pattern": "^\\d+(\\.\\d+)?(ms|s|m|h)?$" },

data/lib/screenkit/schemas/refs/intro.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/intro.json",
+  "$id": "https://screenkit.dev/schemas/refs/intro.json",
   "title": "Intro",
   "properties": {
     "duration": { "$ref": "duration.json" },

data/lib/screenkit/schemas/refs/logo.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/logo.json",
+  "$id": "https://screenkit.dev/schemas/refs/logo.json",
   "title": "Logo",
   "type": "object",
   "required": ["path"],

data/lib/screenkit/schemas/refs/outro.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/outro.json",
+  "$id": "https://screenkit.dev/schemas/refs/outro.json",
   "title": "Outro",
   "required": ["logo"],
   "properties": {

data/lib/screenkit/schemas/refs/position.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/position.json",
+  "$id": "https://screenkit.dev/schemas/refs/position.json",
   "title": "Position",
   "type": "object",
   "properties": {

data/lib/screenkit/schemas/refs/scenes.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/scenes.json",
+  "$id": "https://screenkit.dev/schemas/refs/scenes.json",
   "title": "Scenes",
   "type": "object",
   "required": ["intro", "outro", "segment"],

data/lib/screenkit/schemas/refs/size.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/size.json",
+  "$id": "https://screenkit.dev/schemas/refs/size.json",
   "title": "Size",
   "type": "object",
   "required": ["width", "height"],

data/lib/screenkit/schemas/refs/sound.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/sound.json",
+  "$id": "https://screenkit.dev/schemas/refs/sound.json",
   "title": "Sound",
   "oneOf": [
     {

data/lib/screenkit/schemas/refs/spacing.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/spacing.json",
+  "$id": "https://screenkit.dev/schemas/refs/spacing.json",
   "title": "Spacing (Padding/Margin)",
   "oneOf": [
     {

data/lib/screenkit/schemas/refs/text_style.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/text_style.json",
+  "$id": "https://screenkit.dev/schemas/refs/text_style.json",
   "title": "Text Style",
   "properties": {
     "font_path": {

data/lib/screenkit/schemas/refs/transition.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/transition.json",
+  "$id": "https://screenkit.dev/schemas/refs/transition.json",
   "type": "object",
   "title": "Transition",
   "required": ["duration", "sound"],

data/lib/screenkit/schemas/refs/tts.json

@@ -1,47 +1,10 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/refs/tts.json",
+  "$id": "https://screenkit.dev/schemas/refs/tts.json",
   "title": "The TTS engine used for voiceover",
   "oneOf": [
-    {
-      "type": "boolean",
-      "enum": [false]
-    },
-    {
-      "type": "object",
-      "$ref": "../tts/say.json",
-      "properties": {
-        "engine": {
-          "type": "string",
-          "enum": ["say"],
-          "description": "The TTS engine to use"
-        }
-      }
-    },
-    {
-      "type": "object",
-      "$ref": "../tts/elevenlabs.json",
-      "properties": {
-        "engine": {
-          "type": "string",
-          "enum": ["elevenlabs"],
-          "description": "The TTS engine to use"
-        }
-      }
-    },
-    {
-      "type": "object",
-      "required": ["engine"],
-      "additionalProperties": true,
-      "properties": {
-        "engine": {
-          "type": "string",
-          "description": "The TTS engine to use",
-          "not": {
-            "enum": ["say", "elevenlabs"]
-          }
-        }
-      }
-    }
+    { "type": "boolean", "enum": [false] },
+    { "$ref": "tts_builtin.json" },
+    { "type": "array", "items": { "$ref": "tts_builtin.json" } }
   ]
 }

data/lib/screenkit/schemas/refs/tts_builtin.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://screenkit.dev/schemas/refs/tts_builtin.json",
+  "oneOf": [
+    { "$ref": "../tts/say.json" },
+    { "$ref": "../tts/espeak.json" },
+    { "$ref": "../tts/elevenlabs.json" },
+    {
+      "type": "object",
+      "required": ["engine"],
+      "additionalProperties": true,
+      "properties": {
+        "engine": {
+          "type": "string",
+          "description": "The TTS engine to use",
+          "not": {
+            "enum": ["say", "eleven_labs", "espeak"]
+          }
+        }
+      }
+    }
+  ]
+}