screenkit 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1010cc6a63c96fc1409b7e33b173771f50646520afea83e9a9c11b7f42f43df
-  data.tar.gz: 9af10edc121c4300acf534f59eddc51a7839e279edde1645baec400c6d174267
+  metadata.gz: 97a973d1c6ae7d7c373be709a2233a0b935fae81c706f312c03664e730088780
+  data.tar.gz: 2bf3c1093ee252e020635ef4f98632975eab1c77436e0769d9b2a3c107cd228c
 SHA512:
-  metadata.gz: e1563930fb9c655d0eaf0773eecf483d569bd7309c60dff6eaee93f5e3de37dcffb560eca87460eb42e6313360ef790130869349da6681fe049b0fa8a3afb4e5
-  data.tar.gz: 17e96162245fb27560a12698aa4e2ce1f0d52534e548205d95fd4fb2813fb61100141373114cf8b485beb1c9b4fa7f117a283a6b4a289a03463189dfdc2088ec
+  metadata.gz: 78c95717248ebfa4fab374c612656813bdf6cd0add77dd1c4dfdc65505033c793b73c1645daeb5742670dfc0e6e5aef84100fabd5ec8cc15a011e95d88fa62e0
+  data.tar.gz: 1cca22fd0d8f922fc245be632fcbf587968dc99c402615fe8691eb1e1c45415583f8c1fd2f00c9898c3855a14fd6efe3803c3601102fe8965d563288b5acb4c8

data/.github/workflows/docker.yml

@@ -27,13 +27,19 @@ jobs:
         with:
           ref: ${{ github.event.inputs.ref }}
 
-      - run: >
-          echo "IMAGE_TAG=${{ (inputs.ref || github.ref_name) == 'main' &&
-          'latest' || (inputs.ref || github.ref_name) }}" >> $GITHUB_ENV
+      - name: Set image tags
+        run: |
+          REF="${{ inputs.ref || github.ref_name }}"
+
+          if [[ "$REF" == "main" ]] || [[ "$REF" == v* ]]; then
+            echo "TAGS=-t fnando/screenkit:$REF -t fnando/screenkit:latest" >> $GITHUB_ENV
+          else
+            echo "TAGS=-t fnando/screenkit:$REF" >> $GITHUB_ENV
+          fi
 
       - name: Build Docker Image
         run: |
-          docker build -t fnando/screenkit:${{ env.IMAGE_TAG }} .
+          docker build ${{ env.TAGS }} .
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
@@ -43,4 +49,4 @@ jobs:
 
       - name: Push Docker Image
         run: |
-          docker push fnando/screenkit:${{ env.IMAGE_TAG }}
+          docker push --all-tags fnando/screenkit

data/CHANGELOG.md

@@ -11,13 +11,22 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.6
+
+- [Added] Add `--tts-preset` option to select TTS preset when exporting
+  episodes.
+
+## v0.0.5
+
+- [Added] Add `--skip-bundler` option to skip bundler when generating projects.
+
 ## v0.0.4
 
-- [Fixed] Fixed Gemfile template that was pointing to a local path.
+- [Fixed] Fix Gemfile template that was pointing to a local path.
 
 ## v0.0.3
 
-- [Changed] Do not expand path when creating project/episode.
+- [Changed] Keep path as it is when creating project/episode.
 
 ## v0.0.2
 

data/DOCUMENTATION.md

@@ -39,7 +39,74 @@ gem "screenkit"
 ### Docker
 
 ```bash
-docker run --shm-size=2g -v $PWD:/source --rm -it docker.io/fnando/screenkit
+$ docker run \
+    --platform=linux/amd64 \
+    --shm-size=2g \
+    -v $PWD:/source \
+    --rm -it \
+    docker.io/fnando/screenkit new --skip-bundler example
+      create  Gemfile
+      create  screenkit.yml
+      create  resources
+      create  resources/backtracks/default.aac
+      create  resources/fonts/open-sans/OFL.txt
+      create  resources/fonts/open-sans/OpenSans-ExtraBold.ttf
+      create  resources/fonts/open-sans/OpenSans-SemiBold.ttf
+      create  resources/fonts/open-sans/README.txt
+      create  resources/images/logo.png
+      create  resources/images/watermark.png
+      create  resources/sounds/chime.mp3
+      create  resources/sounds/pop.mp3
+      create  resources/sounds/whoosh.mp3
+
+$ cd example
+
+$ docker run \
+    --platform=linux/amd64 \
+    --shm-size=2g \
+    -v $PWD:/source \
+    --rm -it \
+    docker.io/fnando/screenkit episode new --title 'Hello, world!'
+      create  episodes/001-hello-world/config.yml
+      create  episodes/001-hello-world/scripts
+      create  episodes/001-hello-world/scripts/001.txt
+      create  episodes/001-hello-world/content
+      create  episodes/001-hello-world/content/001.tape
+      create  episodes/001-hello-world/resources
+      create  episodes/001-hello-world/voiceovers
+      create  episodes/001-hello-world/resources/.keep
+      create  episodes/001-hello-world/voiceovers/.keep
+
+$ docker run \
+    --platform=linux/amd64 \
+    --shm-size=2g \
+    -v $PWD:/source \
+    --rm -it \
+    docker.io/fnando/screenkit episode export --dir episodes/001-hello-world
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃  Terminal to screencast, simplified                                      ┃═╗
+┃  ███████╗ ██████╗██████╗ ███████╗███████╗███╗   ██╗██╗  ██╗██╗████████╗  ┃ ║
+┃  ██╔════╝██╔════╝██╔══██╗██╔════╝██╔════╝████╗  ██║██║ ██╔╝██║╚══██╔══╝  ┃ ║
+┃  ███████╗██║     ██████╔╝█████╗  █████╗  ██╔██╗ ██║█████╔╝ ██║   ██║     ┃ ║
+┃  ╚════██║██║     ██╔══██╗██╔══╝  ██╔══╝  ██║╚██╗██║██╔═██╗ ██║   ██║     ┃ ║
+┃  ███████║╚██████╗██║  ██║███████╗███████╗██║ ╚████║██║  ██╗██║   ██║     ┃ ║
+┃  ╚══════╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝   ╚═╝     ┃ ║
+┃                                                               v0.0.5     ┃ ║
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ║
+  ╚══════════════════════════════════════════════════════════════════════════╝
+
+        info  Project root dir: .
+        info  Episode root dir: episodes/001-hello-world
+        info  Matching all 1 segments
+        info  Exported intro in 2.39s
+        info  Exported outro in 2.11s
+        info  Generated voiceover in 0.89s
+        info  Exported videos in 0.00s
+        info  Created callouts in 0.00s
+        info  Created segments in 2.55s
+        info  Merged videos in 8.31s
+        info  Exported video to output/001-hello-world/001-hello-world.mp4
+        info  Exported episode in 16.29s
 ```
 
 Notice that Chrome requires a lot of memory, so you need `--shm-size=2g` (or
@@ -138,7 +205,8 @@ Export an episode to video.
 **Options:**
 
 - `--dir` (required) - Episode directory path
-- `--voice-api-key` - API key for TTS service (e.g., ElevenLabs)
+- `--tts-api-key` - API key for TTS service (e.g., ElevenLabs)
+- `--tts-preset` - TTS preset name that will be used
 - `--overwrite` - Overwrite existing exported files (default: `false`)
 - `--match-segment` - Only export segments matching this string
 - `--output-dir` - Custom output directory path
@@ -220,12 +288,12 @@ watermark:
 watermark: false
 ```
 
-### Callout Definitions
+### Callout Styles
 
 Define reusable callout styles:
 
 ```yaml
-callouts:
+callout_styles:
   shadow_block:
     background_color: "#ffff00"
     shadow: "#2242d3" # Color string or false
@@ -290,8 +358,9 @@ backtrack: false  # Disable for this episode
 
 # Override TTS settings
 tts:
-  engine: elevenlabs
-  voice_id: custom_voice_id
+  - id: eleven_labs
+    engine: eleven_labs
+    voice_id: custom_voice_id
 
 # Override watermark
 watermark: false
@@ -642,9 +711,10 @@ Uses the built-in macOS `say` command.
 
 ```yaml
 tts:
-  engine: say
-  voice: Alex # Optional: Voice name
-  rate: 150 # Words per minute (optional)
+  - id: say
+    engine: say
+    voice: Alex # Optional: Voice name
+    rate: 150 # Words per minute (optional)
 ```
 
 ### ElevenLabs Engine
@@ -653,22 +723,23 @@ Professional AI voice synthesis.
 
 ```yaml
 tts:
-  engine: elevenlabs
-  voice_id: "56AoDkrOh6qfVPDXZ7Pt" # Required: ElevenLabs voice ID
-  language_code: en # 2-letter language code
-
-  # Optional: Voice settings
-  voice_settings:
-    speed: 0.9 # Speech speed (default: 1.0)
-    stability: 0.5 # Voice stability (0.0 - 1.0)
-    similarity: 0.75 # Voice similarity (0.0 - 1.0)
-    style: 0.0 # Speaking style (0.0+)
-
-  # Optional: Output format
-  output_format: mp3_44100_128
-
-  # Optional: Model ID
-  model_id: eleven_monolingual_v1
+  - id: eleven_labs
+    engine: eleven_labs
+    voice_id: "56AoDkrOh6qfVPDXZ7Pt" # Required: ElevenLabs voice ID
+    language_code: en # 2-letter language code
+
+    # Optional: Voice settings
+    voice_settings:
+      speed: 0.9 # Speech speed (default: 1.0)
+      stability: 0.5 # Voice stability (0.0 - 1.0)
+      similarity: 0.75 # Voice similarity (0.0 - 1.0)
+      style: 0.0 # Speaking style (0.0+)
+
+    # Optional: Output format
+    output_format: mp3_44100_128
+
+    # Optional: Model ID
+    model_id: eleven_monolingual_v1
 ```
 
 #### ElevenLabs Output Formats
@@ -729,10 +800,11 @@ end
 
 ```yaml
 tts:
-  engine: custom_engine # Camelized to CustomEngine
-  # Add your custom options here
-  api_key: your_api_key
-  custom_option: value
+  - id: custom_engine
+    engine: custom_engine # Camelized to CustomEngine
+    # Add your custom options here
+    api_key: your_api_key
+    custom_option: value
 ```
 
 The engine name is camelized (e.g., `custom_engine` → `CustomEngine`,
@@ -839,7 +911,7 @@ Today we'll learn how to create amazing screencasts.
 
 Files are matched by number:
 
-- `content/001.tape` → `scripts/001.txt` → `voiceovers/001.aiff`
+- `content/001.tape` → `scripts/001.txt` → `voiceovers/001.:ext`
 - Segments are processed in numerical order
 - Missing scripts create silent segments
 
@@ -962,7 +1034,7 @@ ScreenKit validates configurations against JSON schemas:
 Use the `yaml-language-server` comment for IDE support:
 
 ```yaml
-# yaml-language-server: $schema=../../schemas/project.json
+# yaml-language-server: $schema=https://screenkit.dev/schemas/project.json
 ```
 
 ---
@@ -1048,8 +1120,9 @@ bundle exec screenkit ...
 
 **TTS not working:**
 
-- For ElevenLabs: Set `--voice-api-key`
+- For ElevenLabs: Set `--tts-api-key`
 - For macOS `say`: Verify voice name with `say -v ?`
+- For `espeak`: Ensure `espeak` is installed and in PATH
 
 ---
 

data/Dockerfile

@@ -34,6 +34,7 @@ RUN apk add --no-cache \
     chromium \
     chromium-chromedriver \
     curl \
+    espeak \
     fish \
     ffmpeg \
     font-liberation \

data/lib/screenkit/cli/episode.rb

@@ -55,6 +55,9 @@ module ScreenKit
              type: :array,
              default: [],
              desc: "Additional Ruby files to require"
+      option :tts_preset,
+             type: :string,
+             desc: "Preset voice configuration for TTS"
       def export
         puts Banner.banner if options.banner
 

data/lib/screenkit/cli/root.rb

@@ -7,6 +7,10 @@ module ScreenKit
       subcommand "episode", CLI::Episode
 
       desc "new PATH", "Create a new project"
+      option :bundler,
+             type: :boolean,
+             desc: "Run bundle install after generating the project",
+             default: true
       def new(path)
         generator = Generators::Project.new
         generator.destination_root = path

data/lib/screenkit/exporter/episode.rb

@@ -38,7 +38,7 @@ module ScreenKit
       end
 
       def tts_available?
-        tts_engines.any?(&:available?)
+        tts_engine
       end
 
       def demotape_options
@@ -46,7 +46,14 @@ module ScreenKit
       end
 
       def tts_engine
-        tts_engines.find(&:available?)
+        @tts_engine ||=
+          if options.tts_preset
+            tts_engines.find do |engine|
+              engine.id == options.tts_preset && engine.available?
+            end
+          else
+            tts_engines.find(&:available?)
+          end
       end
 
       def tts_engines

data/lib/screenkit/exporter/segment.rb

@@ -294,9 +294,9 @@ module ScreenKit
           "#{prefix}-#{index}.{png,#{ContentType.video.join(',')}}"
         ).first
 
-        raise "Callout file not found for #{prefix}-#{index}" unless callout_path
+        return callout_path if callout_path
 
-        callout_path
+        raise "Callout file not found for #{prefix}-#{index}"
       end
 
       def video_callout?(callout_path)

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

@@ -84,23 +84,51 @@ watermark:
 # 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`.
+#
+# You can have multiple presets for the same engine. Just set a different
+# configuration block using a different `id`. Then, when you're exporting the
+# video, you can use `--tts-preset <id>`. If you don't provide a preset, the
+# first available engine will be used.
 tts:
   # Apple Say TTS engine configuration.
-  - engine: say
+  - id: say
+    engine: say
+    rate: 150
+    enabled: true
+
+  # Apple Say TTS engine configuration.
+  - id: say_pt_br
+    engine: say
+    voice: "Luciana"
     rate: 150
     enabled: true
 
   # eSpeak TTS engine configuration.
-  - engine: espeak
+  - id: espeak
+    engine: espeak
     rate: 150
     voice: en-us
     enabled: true
 
   # Eleven Labs TTS engine configuration.
-  - engine: eleven_labs
+  - id: eleven_labs
+    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
+
+  # Eleven Labs TTS engine configuration.
+  - id: eleven_labs_mp3_192k
+    engine: eleven_labs
     enabled: true
     voice_id: 56AoDkrOh6qfVPDXZ7Pt
     language_code: en
+    output_format: mp3_44100_192
     voice_settings:
       speed: 0.9
       stability: 0.5

data/lib/screenkit/generators/project.rb

@@ -25,6 +25,8 @@ module ScreenKit
       end
 
       def bundle_install
+        return unless options.bundler
+
         in_root do
           run "bundle install"
         end

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

@@ -7,9 +7,13 @@
     { "$ref": "../tts/elevenlabs.json" },
     {
       "type": "object",
-      "required": ["engine"],
+      "required": ["engine", "id"],
       "additionalProperties": true,
       "properties": {
+        "id": {
+          "type": "string",
+          "description": "A unique identifier for the tts configuration"
+        },
         "engine": {
           "type": "string",
           "description": "The TTS engine to use",

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

@@ -3,9 +3,12 @@
   "$id": "https://screenkit.dev/schemas/tts/elevenlabs.json",
   "title": "The ElevenLabs voice engine options",
   "type": "object",
-  "required": ["voice_id", "engine"],
-  "additionalProperties": false,
+  "required": ["voice_id"],
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

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

@@ -3,9 +3,11 @@
   "$id": "https://screenkit.dev/schemas/tts/espeak.json",
   "title": "espeak synthesizer for English and other languages",
   "type": "object",
-  "required": ["engine"],
-  "additionalProperties": false,
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

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

@@ -3,9 +3,11 @@
   "$id": "https://screenkit.dev/schemas/tts/say.json",
   "title": "The Apple `say` voice engine options",
   "type": "object",
-  "additionalProperties": false,
-  "required": ["engine"],
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

data/lib/screenkit/tts/base.rb

@@ -8,9 +8,13 @@ module ScreenKit
       # Additional options for the tts engine.
       attr_reader :options
 
-      def initialize(enabled: true, **options)
+      # The preset name for the tts engine.
+      attr_reader :id
+
+      def initialize(id: nil, enabled: true, **options)
         @enabled = enabled
         @options = options
+        @id = id
       end
 
       def enabled?

data/lib/screenkit/utils.rb

@@ -2,7 +2,7 @@
 
 module ScreenKit
   module Utils
-    def has_audio?(path)
+    def has_audio?(path) #  rubocop:disable Naming/PredicatePrefix
       cmd = "ffprobe -v error -select_streams a:0 -show_entries " \
             "stream=codec_type -of default=noprint_wrappers=1:nokey=1"
       `#{cmd} #{path}`.strip == "audio"

data/lib/screenkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScreenKit
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screenkit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Nando Vieira
@@ -385,10 +385,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/screenkit
   bug_tracker_uri: https://github.com/fnando/screenkit/issues
-  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.4
-  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.4/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.4/README.md
-  license_uri: https://github.com/fnando/screenkit/tree/v0.0.4/LICENSE.md
+  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.6
+  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.6/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.6/README.md
+  license_uri: https://github.com/fnando/screenkit/tree/v0.0.6/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib