@mytechtoday/augment-extensions 0.2.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +614 -39
- package/augment-extensions/coding-standards/bash/README.md +196 -0
- package/augment-extensions/coding-standards/bash/module.json +163 -0
- package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -0
- package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -0
- package/augment-extensions/coding-standards/css/README.md +40 -0
- package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/css/module.json +44 -0
- package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html/README.md +40 -0
- package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html/module.json +44 -0
- package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/README.md +194 -0
- package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html-css-js/module.json +48 -0
- package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/js/README.md +46 -0
- package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/js/module.json +49 -0
- package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/php/README.md +248 -0
- package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -0
- package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -0
- package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -0
- package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -0
- package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -0
- package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -0
- package/augment-extensions/coding-standards/php/module.json +166 -0
- package/augment-extensions/coding-standards/php/rules/api-development.md +480 -0
- package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -0
- package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -0
- package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -0
- package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -0
- package/augment-extensions/coding-standards/php/rules/documentation.md +425 -0
- package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -0
- package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -0
- package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -0
- package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -0
- package/augment-extensions/coding-standards/php/rules/performance.md +392 -0
- package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -0
- package/augment-extensions/coding-standards/php/rules/security.md +358 -0
- package/augment-extensions/coding-standards/php/rules/testing.md +403 -0
- package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -0
- package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -0
- package/augment-extensions/coding-standards/powershell/README.md +154 -0
- package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -0
- package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -0
- package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -0
- package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -0
- package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -0
- package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -0
- package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -0
- package/augment-extensions/coding-standards/powershell/module.json +165 -0
- package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -0
- package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -0
- package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -0
- package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -0
- package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -0
- package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -0
- package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -0
- package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -0
- package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -0
- package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -0
- package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -0
- package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -0
- package/augment-extensions/coding-standards/python/README.md +12 -8
- package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -0
- package/augment-extensions/coding-standards/python/module.json +8 -4
- package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -0
- package/augment-extensions/coding-standards/python/rules/documentation.md +831 -0
- package/augment-extensions/coding-standards/python/rules/error-handling.md +855 -68
- package/augment-extensions/coding-standards/python/rules/testing.md +409 -0
- package/augment-extensions/coding-standards/python/rules/tooling.md +446 -0
- package/augment-extensions/coding-standards/python/rules/type-hints.md +115 -50
- package/augment-extensions/collections/html-css-js/README.md +82 -0
- package/augment-extensions/collections/html-css-js/collection.json +41 -0
- package/augment-extensions/domain-rules/database/README.md +161 -0
- package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -0
- package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -0
- package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -0
- package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -0
- package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -0
- package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -0
- package/augment-extensions/domain-rules/database/module.json +28 -0
- package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -0
- package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -0
- package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -0
- package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -0
- package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -0
- package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -0
- package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -0
- package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -0
- package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -0
- package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -0
- package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -0
- package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -0
- package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -0
- package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -0
- package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -0
- package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -0
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/README.md +136 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/SCHEMA-VALIDATION-REPORT.md +216 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/brand-kit-example.yaml +292 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/campaign-brief-example.yaml +389 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/content-calendar-example.yaml +643 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/email-newsletter-example.md +376 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/landing-page-example.md +934 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/ppc-ad-copy-example.md +301 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/seo-blog-post-example.md +347 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/social-media-campaign-example.md +606 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/module.json +50 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/affiliate-influencer-marketing.md +593 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/asset-management.md +418 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/brand-consistency.md +210 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/content-marketing.md +337 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/conversion-optimization.md +455 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/direct-sales.md +499 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/email-marketing.md +439 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/legal-compliance.md +227 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/ppc-advertising.md +569 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/seo-optimization.md +470 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/social-media-marketing.md +414 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/universal-marketing.md +177 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/asset-inventory.schema.json +247 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/brand-kit.schema.json +326 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/campaign-brief.schema.json +342 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/color-palette.schema.json +223 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/content-template.schema.json +383 -0
- package/augment-extensions/domain-rules/mcp/README.md +150 -0
- package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -0
- package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -0
- package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -0
- package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -0
- package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -0
- package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -0
- package/augment-extensions/domain-rules/mcp/module.json +49 -0
- package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -0
- package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -0
- package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -0
- package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -0
- package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -0
- package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -0
- package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -0
- package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -0
- package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -0
- package/augment-extensions/workflows/beads/module.json +4 -3
- package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -0
- package/augment-extensions/workflows/beads-integration/README.md +143 -0
- package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -0
- package/augment-extensions/workflows/beads-integration/config/schema.json +140 -0
- package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -0
- package/augment-extensions/workflows/beads-integration/module.json +75 -0
- package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -0
- package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -0
- package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -0
- package/augment-extensions/workflows/database/README.md +195 -0
- package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -0
- package/augment-extensions/workflows/database/examples/migration-example.md +498 -0
- package/augment-extensions/workflows/database/examples/optimization-example.md +496 -0
- package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -0
- package/augment-extensions/workflows/database/module.json +42 -0
- package/augment-extensions/workflows/database/rules/data-migration.md +249 -0
- package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -0
- package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -0
- package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -0
- package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -0
- package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -0
- package/augment-extensions/workflows/database/rules/workflow.md +458 -0
- package/augment-extensions/workflows/openspec/module.json +4 -3
- package/augment-extensions/writing-standards/screenplay/README.md +300 -0
- package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -0
- package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -0
- package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -0
- package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -0
- package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -0
- package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -0
- package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -0
- package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -0
- package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -0
- package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -0
- package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -0
- package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -0
- package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -0
- package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -0
- package/augment-extensions/writing-standards/screenplay/module.json +124 -0
- package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -0
- package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -0
- package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -0
- package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -0
- package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -0
- package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -0
- package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -0
- package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -0
- package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -0
- package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -0
- package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -0
- package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -0
- package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -0
- package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -0
- package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -0
- package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -0
- package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -0
- package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -0
- package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -0
- package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -0
- package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -0
- package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -0
- package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -0
- package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -0
- package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -0
- package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -0
- package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -0
- package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -0
- package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -0
- package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -0
- package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -0
- package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -0
- package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -0
- package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -0
- package/cli/MODULES.md +302 -0
- package/cli/dist/cli.js +168 -10
- package/cli/dist/cli.js.map +1 -1
- package/cli/dist/commands/catalog.d.ts +13 -0
- package/cli/dist/commands/catalog.d.ts.map +1 -0
- package/cli/dist/commands/catalog.js +104 -0
- package/cli/dist/commands/catalog.js.map +1 -0
- package/cli/dist/commands/gui.d.ts +6 -0
- package/cli/dist/commands/gui.d.ts.map +1 -0
- package/cli/dist/commands/gui.js +211 -0
- package/cli/dist/commands/gui.js.map +1 -0
- package/cli/dist/commands/init.d.ts.map +1 -1
- package/cli/dist/commands/init.js +12 -0
- package/cli/dist/commands/init.js.map +1 -1
- package/cli/dist/commands/install-rules.d.ts +14 -0
- package/cli/dist/commands/install-rules.d.ts.map +1 -0
- package/cli/dist/commands/install-rules.js +127 -0
- package/cli/dist/commands/install-rules.js.map +1 -0
- package/cli/dist/commands/link.d.ts.map +1 -1
- package/cli/dist/commands/link.js +9 -11
- package/cli/dist/commands/link.js.map +1 -1
- package/cli/dist/commands/list.d.ts.map +1 -1
- package/cli/dist/commands/list.js +11 -28
- package/cli/dist/commands/list.js.map +1 -1
- package/cli/dist/commands/mcp.d.ts +48 -0
- package/cli/dist/commands/mcp.d.ts.map +1 -0
- package/cli/dist/commands/mcp.js +229 -0
- package/cli/dist/commands/mcp.js.map +1 -0
- package/cli/dist/commands/self-remove.d.ts +7 -0
- package/cli/dist/commands/self-remove.d.ts.map +1 -0
- package/cli/dist/commands/self-remove.js +179 -0
- package/cli/dist/commands/self-remove.js.map +1 -0
- package/cli/dist/commands/show.d.ts +19 -0
- package/cli/dist/commands/show.d.ts.map +1 -1
- package/cli/dist/commands/show.js +478 -63
- package/cli/dist/commands/show.js.map +1 -1
- package/cli/dist/commands/skill.d.ts +67 -0
- package/cli/dist/commands/skill.d.ts.map +1 -0
- package/cli/dist/commands/skill.js +513 -0
- package/cli/dist/commands/skill.js.map +1 -0
- package/cli/dist/commands/unlink.d.ts +6 -0
- package/cli/dist/commands/unlink.d.ts.map +1 -0
- package/cli/dist/commands/unlink.js +115 -0
- package/cli/dist/commands/unlink.js.map +1 -0
- package/cli/dist/commands/validate.d.ts +6 -0
- package/cli/dist/commands/validate.d.ts.map +1 -0
- package/cli/dist/commands/validate.js +159 -0
- package/cli/dist/commands/validate.js.map +1 -0
- package/cli/dist/types/gui.d.ts +62 -0
- package/cli/dist/types/gui.d.ts.map +1 -0
- package/cli/dist/types/gui.js +30 -0
- package/cli/dist/types/gui.js.map +1 -0
- package/cli/dist/utils/catalog-sync.d.ts +22 -0
- package/cli/dist/utils/catalog-sync.d.ts.map +1 -0
- package/cli/dist/utils/catalog-sync.js +157 -0
- package/cli/dist/utils/catalog-sync.js.map +1 -0
- package/cli/dist/utils/character-count.d.ts +56 -0
- package/cli/dist/utils/character-count.d.ts.map +1 -0
- package/cli/dist/utils/character-count.js +190 -0
- package/cli/dist/utils/character-count.js.map +1 -0
- package/cli/dist/utils/documentation-validator.d.ts +18 -0
- package/cli/dist/utils/documentation-validator.d.ts.map +1 -0
- package/cli/dist/utils/documentation-validator.js +233 -0
- package/cli/dist/utils/documentation-validator.js.map +1 -0
- package/cli/dist/utils/gui-helpers.d.ts +23 -0
- package/cli/dist/utils/gui-helpers.d.ts.map +1 -0
- package/cli/dist/utils/gui-helpers.js +159 -0
- package/cli/dist/utils/gui-helpers.js.map +1 -0
- package/cli/dist/utils/install-rules.d.ts +32 -0
- package/cli/dist/utils/install-rules.d.ts.map +1 -0
- package/cli/dist/utils/install-rules.js +375 -0
- package/cli/dist/utils/install-rules.js.map +1 -0
- package/cli/dist/utils/mcp-integration.d.ts +70 -0
- package/cli/dist/utils/mcp-integration.d.ts.map +1 -0
- package/cli/dist/utils/mcp-integration.js +292 -0
- package/cli/dist/utils/mcp-integration.js.map +1 -0
- package/cli/dist/utils/module-system.d.ts +232 -0
- package/cli/dist/utils/module-system.d.ts.map +1 -0
- package/cli/dist/utils/module-system.js +900 -0
- package/cli/dist/utils/module-system.js.map +1 -0
- package/cli/dist/utils/modules-catalog.d.ts +33 -0
- package/cli/dist/utils/modules-catalog.d.ts.map +1 -0
- package/cli/dist/utils/modules-catalog.js +163 -0
- package/cli/dist/utils/modules-catalog.js.map +1 -0
- package/cli/dist/utils/rule-install-hooks.d.ts +19 -0
- package/cli/dist/utils/rule-install-hooks.d.ts.map +1 -0
- package/cli/dist/utils/rule-install-hooks.js +224 -0
- package/cli/dist/utils/rule-install-hooks.js.map +1 -0
- package/cli/dist/utils/skill-system.d.ts +95 -0
- package/cli/dist/utils/skill-system.d.ts.map +1 -0
- package/cli/dist/utils/skill-system.js +313 -0
- package/cli/dist/utils/skill-system.js.map +1 -0
- package/modules.md +559 -105
- package/package.json +17 -6
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
# Screenplay Examples Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This guide provides detailed explanations and annotations for all example files in the screenplay module.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Fountain Examples
|
|
10
|
+
|
|
11
|
+
### AAA Hollywood Scene (aaa-hollywood-scene.fountain)
|
|
12
|
+
|
|
13
|
+
**Purpose:** Demonstrates high-stakes action sequence with visual spectacle
|
|
14
|
+
|
|
15
|
+
**Key Features:**
|
|
16
|
+
- Fast-paced action
|
|
17
|
+
- Visual effects notes
|
|
18
|
+
- Clear spatial geography
|
|
19
|
+
- Escalating tension
|
|
20
|
+
- Cinematic set pieces
|
|
21
|
+
|
|
22
|
+
**What to Learn:**
|
|
23
|
+
- How to write action that's visual and dynamic
|
|
24
|
+
- Balancing description with pacing
|
|
25
|
+
- Using sound effects effectively
|
|
26
|
+
- Creating tension through action
|
|
27
|
+
|
|
28
|
+
**Category:** AAA Hollywood Films
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
### Independent Film Monologue (independent-monologue.fountain)
|
|
33
|
+
|
|
34
|
+
**Purpose:** Demonstrates character-driven emotional scene
|
|
35
|
+
|
|
36
|
+
**Key Features:**
|
|
37
|
+
- Deep character exploration
|
|
38
|
+
- Emotional authenticity
|
|
39
|
+
- Minimal action, maximum emotion
|
|
40
|
+
- Subtext and layered meaning
|
|
41
|
+
- Natural, realistic dialogue
|
|
42
|
+
|
|
43
|
+
**What to Learn:**
|
|
44
|
+
- Writing emotional monologues
|
|
45
|
+
- Character voice and authenticity
|
|
46
|
+
- Using silence and pauses
|
|
47
|
+
- Creating intimacy on the page
|
|
48
|
+
|
|
49
|
+
**Category:** Independent Films
|
|
50
|
+
|
|
51
|
+
**Character Analysis:**
|
|
52
|
+
- Sarah is grieving, isolated, struggling
|
|
53
|
+
- Monologue reveals internal conflict
|
|
54
|
+
- Physical actions support emotional state
|
|
55
|
+
- Vulnerability without melodrama
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
### TV Episode Teaser (tv-episode-teaser.fountain)
|
|
60
|
+
|
|
61
|
+
**Purpose:** Demonstrates cold open/teaser structure for TV series
|
|
62
|
+
|
|
63
|
+
**Key Features:**
|
|
64
|
+
- Hook within first 30 seconds
|
|
65
|
+
- Escalating mystery
|
|
66
|
+
- Cliffhanger ending
|
|
67
|
+
- Series-appropriate tone
|
|
68
|
+
- Act break structure
|
|
69
|
+
|
|
70
|
+
**What to Learn:**
|
|
71
|
+
- Creating compelling teasers
|
|
72
|
+
- Building suspense
|
|
73
|
+
- Ending on cliffhanger
|
|
74
|
+
- Establishing tone quickly
|
|
75
|
+
|
|
76
|
+
**Category:** TV Series (Drama/Thriller)
|
|
77
|
+
|
|
78
|
+
**Structure Breakdown:**
|
|
79
|
+
- Pages 1-2: Setup (lighthouse keeper, routine)
|
|
80
|
+
- Pages 2-4: Inciting incident (distress call)
|
|
81
|
+
- Pages 4-6: Investigation (approaching boat)
|
|
82
|
+
- Pages 6-8: Escalation (mysterious circumstances)
|
|
83
|
+
- Pages 8-10: Cliffhanger (trapped, something in cabin)
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### News Broadcast Segment (news-segment.fountain)
|
|
88
|
+
|
|
89
|
+
**Purpose:** Demonstrates news broadcast format with timing and production notes
|
|
90
|
+
|
|
91
|
+
**Key Features:**
|
|
92
|
+
- Timing marks (critical for broadcast)
|
|
93
|
+
- B-roll notes
|
|
94
|
+
- Interview segments
|
|
95
|
+
- Production notes
|
|
96
|
+
- Call-to-action
|
|
97
|
+
|
|
98
|
+
**What to Learn:**
|
|
99
|
+
- Broadcast script formatting
|
|
100
|
+
- Timing and pacing for news
|
|
101
|
+
- Integrating B-roll and interviews
|
|
102
|
+
- Production considerations
|
|
103
|
+
|
|
104
|
+
**Category:** News Broadcasts
|
|
105
|
+
|
|
106
|
+
**Production Elements:**
|
|
107
|
+
- Total runtime: 2:30
|
|
108
|
+
- Anchor segments: 1:00
|
|
109
|
+
- Interviews: 1:00
|
|
110
|
+
- B-roll: 0:30
|
|
111
|
+
- Graphics: 3 total
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
### 30-Second Commercial (commercial-30sec.fountain)
|
|
116
|
+
|
|
117
|
+
**Purpose:** Demonstrates commercial script with precise timing
|
|
118
|
+
|
|
119
|
+
**Key Features:**
|
|
120
|
+
- Exact timing breakdown
|
|
121
|
+
- Visual storytelling
|
|
122
|
+
- Brand messaging
|
|
123
|
+
- Call-to-action
|
|
124
|
+
- Production notes
|
|
125
|
+
|
|
126
|
+
**What to Learn:**
|
|
127
|
+
- Writing for precise time constraints
|
|
128
|
+
- Visual storytelling without dialogue
|
|
129
|
+
- Brand integration
|
|
130
|
+
- Production planning
|
|
131
|
+
|
|
132
|
+
**Category:** Commercials
|
|
133
|
+
|
|
134
|
+
**Timing Breakdown:**
|
|
135
|
+
- :00-:12 - Opening visual (mountain summit)
|
|
136
|
+
- :12-:24 - Product messaging (voiceover)
|
|
137
|
+
- :24-:30 - Call-to-action (brand/tagline)
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## YAML Examples
|
|
142
|
+
|
|
143
|
+
### Character Profile Example (character-profile-example.yaml)
|
|
144
|
+
|
|
145
|
+
**Purpose:** Demonstrates comprehensive character development using schema
|
|
146
|
+
|
|
147
|
+
**Character:** Sarah Mitchell (protagonist)
|
|
148
|
+
|
|
149
|
+
**Key Features:**
|
|
150
|
+
- Complete character profile
|
|
151
|
+
- Physical and psychological traits
|
|
152
|
+
- Backstory with formative events
|
|
153
|
+
- Character arc definition
|
|
154
|
+
- Relationship mapping
|
|
155
|
+
- Voice and speech patterns
|
|
156
|
+
|
|
157
|
+
**What to Learn:**
|
|
158
|
+
- Creating three-dimensional characters
|
|
159
|
+
- Connecting backstory to present behavior
|
|
160
|
+
- Defining clear character arcs
|
|
161
|
+
- Establishing distinct voice
|
|
162
|
+
|
|
163
|
+
**Usage:**
|
|
164
|
+
- Use as template for your characters
|
|
165
|
+
- Adapt depth to character importance
|
|
166
|
+
- Ensure consistency with screenplay
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
### Beat Sheet Example (beat-sheet-example.yaml)
|
|
171
|
+
|
|
172
|
+
**Purpose:** Demonstrates Save the Cat beat structure
|
|
173
|
+
|
|
174
|
+
**Story:** "The Weight We Carry" (psychological drama)
|
|
175
|
+
|
|
176
|
+
**Key Features:**
|
|
177
|
+
- All 15 Save the Cat beats
|
|
178
|
+
- Page number guidelines
|
|
179
|
+
- Beat descriptions
|
|
180
|
+
- Thematic connections
|
|
181
|
+
- Character arc integration
|
|
182
|
+
|
|
183
|
+
**What to Learn:**
|
|
184
|
+
- Applying Save the Cat structure
|
|
185
|
+
- Timing major plot points
|
|
186
|
+
- Connecting beats to theme
|
|
187
|
+
- Balancing plot and character
|
|
188
|
+
|
|
189
|
+
**Structure Highlights:**
|
|
190
|
+
- Opening Image (p.1): Sarah isolated in car
|
|
191
|
+
- Catalyst (p.12): Meets Elena, sees her mother
|
|
192
|
+
- Midpoint (p.55): False victory, stakes raised
|
|
193
|
+
- All Is Lost (p.75): Elena overdoses
|
|
194
|
+
- Final Image (p.110): Sarah connected, moving forward
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
### Plot Outline Example (plot-outline-example.yaml)
|
|
199
|
+
|
|
200
|
+
**Purpose:** Demonstrates three-act structure with sequences and scenes
|
|
201
|
+
|
|
202
|
+
**Story:** "The Weight We Carry"
|
|
203
|
+
|
|
204
|
+
**Key Features:**
|
|
205
|
+
- Three-act structure
|
|
206
|
+
- Sequences within acts
|
|
207
|
+
- Individual scene breakdowns
|
|
208
|
+
- Turning points
|
|
209
|
+
- Subplots
|
|
210
|
+
|
|
211
|
+
**What to Learn:**
|
|
212
|
+
- Organizing screenplay structure
|
|
213
|
+
- Breaking story into manageable pieces
|
|
214
|
+
- Scene-by-scene planning
|
|
215
|
+
- Integrating subplots
|
|
216
|
+
|
|
217
|
+
**Act Breakdown:**
|
|
218
|
+
- Act 1 (pp.1-25): Setup - Sarah's world, catalyst
|
|
219
|
+
- Act 2 (pp.26-85): Confrontation - Progress and unraveling
|
|
220
|
+
- Act 3 (pp.86-110): Resolution - Healing and transformation
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## Using the Examples
|
|
225
|
+
|
|
226
|
+
### For Learning
|
|
227
|
+
|
|
228
|
+
1. **Read the example**
|
|
229
|
+
2. **Study the annotations** (this guide)
|
|
230
|
+
3. **Identify techniques** used
|
|
231
|
+
4. **Apply to your work**
|
|
232
|
+
|
|
233
|
+
### For Templates
|
|
234
|
+
|
|
235
|
+
1. **Copy example structure**
|
|
236
|
+
2. **Replace with your content**
|
|
237
|
+
3. **Maintain formatting**
|
|
238
|
+
4. **Adapt to your needs**
|
|
239
|
+
|
|
240
|
+
### For Reference
|
|
241
|
+
|
|
242
|
+
1. **Keep examples handy**
|
|
243
|
+
2. **Refer when stuck**
|
|
244
|
+
3. **Compare your work**
|
|
245
|
+
4. **Validate formatting**
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## Common Patterns Across Examples
|
|
250
|
+
|
|
251
|
+
### Visual Storytelling
|
|
252
|
+
|
|
253
|
+
All examples prioritize showing over telling:
|
|
254
|
+
- Action reveals character
|
|
255
|
+
- Visuals convey emotion
|
|
256
|
+
- Minimal exposition
|
|
257
|
+
- Specific, concrete details
|
|
258
|
+
|
|
259
|
+
### Formatting Consistency
|
|
260
|
+
|
|
261
|
+
All examples follow industry standards:
|
|
262
|
+
- Proper Fountain syntax
|
|
263
|
+
- Correct element formatting
|
|
264
|
+
- Appropriate spacing
|
|
265
|
+
- Professional appearance
|
|
266
|
+
|
|
267
|
+
### Category Appropriateness
|
|
268
|
+
|
|
269
|
+
Each example fits its category:
|
|
270
|
+
- AAA Hollywood: Spectacle and action
|
|
271
|
+
- Independent: Character and emotion
|
|
272
|
+
- TV: Structure and hooks
|
|
273
|
+
- News: Information and timing
|
|
274
|
+
- Commercial: Brand and brevity
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## Practice Exercises
|
|
279
|
+
|
|
280
|
+
### Exercise 1: Adaptation
|
|
281
|
+
|
|
282
|
+
Take the independent monologue and adapt it for:
|
|
283
|
+
- AAA Hollywood (add action, external conflict)
|
|
284
|
+
- TV Series (add cliffhanger, series context)
|
|
285
|
+
|
|
286
|
+
### Exercise 2: Structure
|
|
287
|
+
|
|
288
|
+
Use the beat sheet example to outline:
|
|
289
|
+
- Your own story
|
|
290
|
+
- A favorite film
|
|
291
|
+
- A story idea
|
|
292
|
+
|
|
293
|
+
### Exercise 3: Character
|
|
294
|
+
|
|
295
|
+
Create a character profile for:
|
|
296
|
+
- Protagonist of your screenplay
|
|
297
|
+
- Antagonist
|
|
298
|
+
- Key supporting character
|
|
299
|
+
|
|
300
|
+
### Exercise 4: Format
|
|
301
|
+
|
|
302
|
+
Write a scene in the style of:
|
|
303
|
+
- AAA Hollywood action
|
|
304
|
+
- Independent character moment
|
|
305
|
+
- TV teaser
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Resources
|
|
310
|
+
|
|
311
|
+
- All example files in `examples/` directory
|
|
312
|
+
- Schema files in `schemas/` directory
|
|
313
|
+
- Rule files in `rules/` directory
|
|
314
|
+
- Module README for overview
|
|
315
|
+
|
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
# Screenplay Formatting Validation
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This guide provides comprehensive validation rules for screenplay formatting against AMPAS (Academy of Motion Picture Arts and Sciences) standards.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## AMPAS Formatting Standards
|
|
10
|
+
|
|
11
|
+
### Page Setup
|
|
12
|
+
|
|
13
|
+
**Paper Size:** US Letter (8.5" x 11")
|
|
14
|
+
|
|
15
|
+
**Margins:**
|
|
16
|
+
- Top: 1.0"
|
|
17
|
+
- Bottom: 0.5" - 1.0"
|
|
18
|
+
- Left: 1.5"
|
|
19
|
+
- Right: 1.0"
|
|
20
|
+
|
|
21
|
+
**Font:**
|
|
22
|
+
- Courier or Courier New
|
|
23
|
+
- 12 point
|
|
24
|
+
- Fixed-width (monospace)
|
|
25
|
+
|
|
26
|
+
**Line Spacing:**
|
|
27
|
+
- Single-spaced within elements
|
|
28
|
+
- Double-spaced between elements
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Element Formatting
|
|
33
|
+
|
|
34
|
+
### Scene Headings
|
|
35
|
+
|
|
36
|
+
**Format:**
|
|
37
|
+
```
|
|
38
|
+
INT. LOCATION - TIME
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Specifications:**
|
|
42
|
+
- Left margin: 1.5"
|
|
43
|
+
- All caps
|
|
44
|
+
- Blank line before and after
|
|
45
|
+
- Must start with: INT, EXT, INT./EXT, I/E
|
|
46
|
+
|
|
47
|
+
**Examples:**
|
|
48
|
+
```fountain
|
|
49
|
+
INT. COFFEE SHOP - DAY
|
|
50
|
+
|
|
51
|
+
EXT. CITY STREET - NIGHT
|
|
52
|
+
|
|
53
|
+
INT./EXT. CAR - MOVING - DUSK
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Validation:**
|
|
57
|
+
- [ ] Starts with INT, EXT, or variant
|
|
58
|
+
- [ ] All caps
|
|
59
|
+
- [ ] Includes location
|
|
60
|
+
- [ ] Includes time of day
|
|
61
|
+
- [ ] Blank line before
|
|
62
|
+
- [ ] Blank line after
|
|
63
|
+
|
|
64
|
+
### Action/Description
|
|
65
|
+
|
|
66
|
+
**Specifications:**
|
|
67
|
+
- Left margin: 1.5"
|
|
68
|
+
- Right margin: 1.0"
|
|
69
|
+
- Width: 6.0"
|
|
70
|
+
- Mixed case (except sound effects)
|
|
71
|
+
- Blank line before and after
|
|
72
|
+
|
|
73
|
+
**Examples:**
|
|
74
|
+
```fountain
|
|
75
|
+
Sarah walks to the window.
|
|
76
|
+
|
|
77
|
+
The phone RINGS.
|
|
78
|
+
|
|
79
|
+
She doesn't answer.
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Validation:**
|
|
83
|
+
- [ ] Left-aligned
|
|
84
|
+
- [ ] Proper margins
|
|
85
|
+
- [ ] Sound effects in caps
|
|
86
|
+
- [ ] Paragraphs 3-4 lines max
|
|
87
|
+
- [ ] Blank line between paragraphs
|
|
88
|
+
|
|
89
|
+
### Character Names
|
|
90
|
+
|
|
91
|
+
**Specifications:**
|
|
92
|
+
- Left margin: 3.7"
|
|
93
|
+
- All caps
|
|
94
|
+
- Extensions in parentheses
|
|
95
|
+
- Blank line before (from action)
|
|
96
|
+
|
|
97
|
+
**Examples:**
|
|
98
|
+
```fountain
|
|
99
|
+
SARAH
|
|
100
|
+
|
|
101
|
+
MARCUS (O.S.)
|
|
102
|
+
|
|
103
|
+
NARRATOR (V.O.)
|
|
104
|
+
|
|
105
|
+
SARAH (CONT'D)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Validation:**
|
|
109
|
+
- [ ] All caps
|
|
110
|
+
- [ ] Proper indentation (3.7")
|
|
111
|
+
- [ ] Extensions formatted correctly
|
|
112
|
+
- [ ] Consistent throughout screenplay
|
|
113
|
+
|
|
114
|
+
### Dialogue
|
|
115
|
+
|
|
116
|
+
**Specifications:**
|
|
117
|
+
- Left margin: 2.5"
|
|
118
|
+
- Right margin: 2.5"
|
|
119
|
+
- Width: 3.5"
|
|
120
|
+
- Mixed case
|
|
121
|
+
- No blank line after character name
|
|
122
|
+
|
|
123
|
+
**Examples:**
|
|
124
|
+
```fountain
|
|
125
|
+
SARAH
|
|
126
|
+
I can't believe this is happening.
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Validation:**
|
|
130
|
+
- [ ] Proper margins (2.5" left, 2.5" right)
|
|
131
|
+
- [ ] Follows character name immediately
|
|
132
|
+
- [ ] Natural language
|
|
133
|
+
- [ ] Appropriate length
|
|
134
|
+
|
|
135
|
+
### Parentheticals
|
|
136
|
+
|
|
137
|
+
**Specifications:**
|
|
138
|
+
- Left margin: 3.1"
|
|
139
|
+
- Right margin: 3.5"
|
|
140
|
+
- Wrapped in parentheses
|
|
141
|
+
- Lowercase (except proper nouns)
|
|
142
|
+
|
|
143
|
+
**Examples:**
|
|
144
|
+
```fountain
|
|
145
|
+
SARAH
|
|
146
|
+
(to Marcus)
|
|
147
|
+
I need to tell you something.
|
|
148
|
+
|
|
149
|
+
MARCUS
|
|
150
|
+
(nervous)
|
|
151
|
+
What is it?
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**Validation:**
|
|
155
|
+
- [ ] Proper indentation (3.1")
|
|
156
|
+
- [ ] Wrapped in parentheses
|
|
157
|
+
- [ ] Lowercase
|
|
158
|
+
- [ ] Brief (2-3 words ideal)
|
|
159
|
+
|
|
160
|
+
### Transitions
|
|
161
|
+
|
|
162
|
+
**Specifications:**
|
|
163
|
+
- Right-aligned (6.0" from left)
|
|
164
|
+
- All caps
|
|
165
|
+
- End with colon or period
|
|
166
|
+
- Blank line before and after
|
|
167
|
+
|
|
168
|
+
**Examples:**
|
|
169
|
+
```fountain
|
|
170
|
+
CUT TO:
|
|
171
|
+
|
|
172
|
+
FADE OUT.
|
|
173
|
+
|
|
174
|
+
DISSOLVE TO:
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Validation:**
|
|
178
|
+
- [ ] Right-aligned
|
|
179
|
+
- [ ] All caps
|
|
180
|
+
- [ ] Proper punctuation
|
|
181
|
+
- [ ] Used sparingly
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Page Count Standards
|
|
186
|
+
|
|
187
|
+
### Feature Films
|
|
188
|
+
|
|
189
|
+
**Target:** 90-120 pages
|
|
190
|
+
- 90-100 pages: Tight, fast-paced
|
|
191
|
+
- 100-110 pages: Standard
|
|
192
|
+
- 110-120 pages: Epic, complex
|
|
193
|
+
|
|
194
|
+
**Rule of Thumb:** 1 page = 1 minute screen time
|
|
195
|
+
|
|
196
|
+
### Television
|
|
197
|
+
|
|
198
|
+
**One-Hour Drama:** 50-60 pages
|
|
199
|
+
- Network: 50-55 pages (with commercials)
|
|
200
|
+
- Cable/Streaming: 55-60 pages
|
|
201
|
+
|
|
202
|
+
**Half-Hour Comedy:** 25-35 pages
|
|
203
|
+
- Network: 25-30 pages (with commercials)
|
|
204
|
+
- Cable/Streaming: 30-35 pages
|
|
205
|
+
|
|
206
|
+
**Half-Hour Drama:** 30-40 pages
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## Title Page Format
|
|
211
|
+
|
|
212
|
+
**Required Elements:**
|
|
213
|
+
```
|
|
214
|
+
TITLE
|
|
215
|
+
(all caps, centered)
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
Written by
|
|
219
|
+
(centered, lowercase)
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
Author Name
|
|
223
|
+
(centered, mixed case)
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
Contact Info
|
|
227
|
+
(bottom right)
|
|
228
|
+
|
|
229
|
+
Draft Date
|
|
230
|
+
(bottom right)
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**Validation:**
|
|
234
|
+
- [ ] Title centered and in caps
|
|
235
|
+
- [ ] "Written by" centered
|
|
236
|
+
- [ ] Author name centered
|
|
237
|
+
- [ ] Contact info bottom right
|
|
238
|
+
- [ ] Draft date included
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## Common Formatting Errors
|
|
243
|
+
|
|
244
|
+
### Scene Headings
|
|
245
|
+
|
|
246
|
+
**❌ Incorrect:**
|
|
247
|
+
```
|
|
248
|
+
int. coffee shop - day (not all caps)
|
|
249
|
+
INT COFFEE SHOP DAY (missing hyphens)
|
|
250
|
+
COFFEE SHOP - DAY (missing INT/EXT)
|
|
251
|
+
INT. COFFEE SHOP (missing time)
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
**✅ Correct:**
|
|
255
|
+
```
|
|
256
|
+
INT. COFFEE SHOP - DAY
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Character Names
|
|
260
|
+
|
|
261
|
+
**❌ Incorrect:**
|
|
262
|
+
```
|
|
263
|
+
Sarah (not all caps)
|
|
264
|
+
SARAH(O.S.) (no space)
|
|
265
|
+
sarah (o.s.) (not all caps)
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
**✅ Correct:**
|
|
269
|
+
```
|
|
270
|
+
SARAH
|
|
271
|
+
SARAH (O.S.)
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Dialogue
|
|
275
|
+
|
|
276
|
+
**❌ Incorrect:**
|
|
277
|
+
```
|
|
278
|
+
SARAH: I can't do this. (colon after name)
|
|
279
|
+
|
|
280
|
+
SARAH
|
|
281
|
+
I can't do this. (indented)
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
**✅ Correct:**
|
|
285
|
+
```
|
|
286
|
+
SARAH
|
|
287
|
+
I can't do this.
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Action
|
|
291
|
+
|
|
292
|
+
**❌ Incorrect:**
|
|
293
|
+
```
|
|
294
|
+
SARAH WALKS TO THE WINDOW. (all caps)
|
|
295
|
+
|
|
296
|
+
Sarah walks to the window and stares out at the rain for a long moment
|
|
297
|
+
before turning back to Marcus with tears streaming down her face as she
|
|
298
|
+
contemplates what to say next. (too long)
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
**✅ Correct:**
|
|
302
|
+
```
|
|
303
|
+
Sarah walks to the window.
|
|
304
|
+
|
|
305
|
+
She stares out at the rain.
|
|
306
|
+
|
|
307
|
+
A beat.
|
|
308
|
+
|
|
309
|
+
She turns back to Marcus, tears in her eyes.
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
|
|
314
|
+
## Validation Checklist
|
|
315
|
+
|
|
316
|
+
### Overall Format
|
|
317
|
+
|
|
318
|
+
- [ ] Courier 12pt font
|
|
319
|
+
- [ ] Proper margins (1.5" left, 1" right/top/bottom)
|
|
320
|
+
- [ ] US Letter paper size
|
|
321
|
+
- [ ] Single-spaced within elements
|
|
322
|
+
- [ ] Double-spaced between elements
|
|
323
|
+
|
|
324
|
+
### Scene Headings
|
|
325
|
+
|
|
326
|
+
- [ ] All caps
|
|
327
|
+
- [ ] Start with INT/EXT
|
|
328
|
+
- [ ] Include location and time
|
|
329
|
+
- [ ] Blank lines before and after
|
|
330
|
+
|
|
331
|
+
### Characters and Dialogue
|
|
332
|
+
|
|
333
|
+
- [ ] Character names all caps
|
|
334
|
+
- [ ] Proper indentation
|
|
335
|
+
- [ ] Natural dialogue
|
|
336
|
+
- [ ] Parentheticals formatted correctly
|
|
337
|
+
|
|
338
|
+
### Action
|
|
339
|
+
|
|
340
|
+
- [ ] Mixed case (except sound effects)
|
|
341
|
+
- [ ] Short paragraphs (3-4 lines)
|
|
342
|
+
- [ ] Visual and specific
|
|
343
|
+
- [ ] No camera directions (unless appropriate)
|
|
344
|
+
|
|
345
|
+
### Page Count
|
|
346
|
+
|
|
347
|
+
- [ ] Appropriate for format
|
|
348
|
+
- [ ] Approximately 1 page = 1 minute
|
|
349
|
+
|
|
350
|
+
### Title Page
|
|
351
|
+
|
|
352
|
+
- [ ] Properly formatted
|
|
353
|
+
- [ ] All required information
|
|
354
|
+
- [ ] Professional appearance
|
|
355
|
+
|
|
356
|
+
---
|
|
357
|
+
|
|
358
|
+
## Automated Validation Tools
|
|
359
|
+
|
|
360
|
+
**Better Fountain (VS Code):**
|
|
361
|
+
- Real-time syntax checking
|
|
362
|
+
- Format validation
|
|
363
|
+
- Page count tracking
|
|
364
|
+
|
|
365
|
+
**Highland 2:**
|
|
366
|
+
- Industry-standard formatting
|
|
367
|
+
- Automatic validation
|
|
368
|
+
- Export to multiple formats
|
|
369
|
+
|
|
370
|
+
**Fade In:**
|
|
371
|
+
- Professional formatting
|
|
372
|
+
- Validation against industry standards
|
|
373
|
+
- Collaboration features
|
|
374
|
+
|
|
375
|
+
---
|
|
376
|
+
|
|
377
|
+
## Manual Validation Process
|
|
378
|
+
|
|
379
|
+
1. **Visual Inspection:**
|
|
380
|
+
- Check overall appearance
|
|
381
|
+
- Verify consistent formatting
|
|
382
|
+
- Look for obvious errors
|
|
383
|
+
|
|
384
|
+
2. **Element-by-Element Review:**
|
|
385
|
+
- Scene headings
|
|
386
|
+
- Character names
|
|
387
|
+
- Dialogue
|
|
388
|
+
- Action
|
|
389
|
+
- Transitions
|
|
390
|
+
|
|
391
|
+
3. **Page Count Check:**
|
|
392
|
+
- Verify appropriate length
|
|
393
|
+
- Check pacing (1 page = 1 minute)
|
|
394
|
+
|
|
395
|
+
4. **Read-Through:**
|
|
396
|
+
- Read entire screenplay
|
|
397
|
+
- Note formatting inconsistencies
|
|
398
|
+
- Mark areas for revision
|
|
399
|
+
|
|
400
|
+
5. **Final Validation:**
|
|
401
|
+
- Run automated tools
|
|
402
|
+
- Manual checklist review
|
|
403
|
+
- Professional appearance check
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
## Resources
|
|
408
|
+
|
|
409
|
+
- AMPAS Screenplay Format Guide
|
|
410
|
+
- The Hollywood Standard by Christopher Riley
|
|
411
|
+
- Better Fountain Documentation
|
|
412
|
+
- Industry Standard Examples
|
|
413
|
+
|