@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,300 @@
|
|
|
1
|
+
# Screenplay Writing Standards
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Comprehensive screenplay writing and crafting standards for AI-driven content creation across multiple formats and industries.
|
|
6
|
+
|
|
7
|
+
**Version**: 1.0.0
|
|
8
|
+
**Type**: writing-standards
|
|
9
|
+
**Character Count**: ~163,500
|
|
10
|
+
|
|
11
|
+
## Key Benefits
|
|
12
|
+
|
|
13
|
+
✅ **Industry-Standard Formatting** - AMPAS Nicholl Fellowship formatting standards
|
|
14
|
+
✅ **Narrative Frameworks** - Syd Field, Blake Snyder, Joseph Campbell structures
|
|
15
|
+
✅ **Category-Specific Rules** - 8 screenplay categories (Hollywood, indie, TV, web, news, commercials, streaming, live TV)
|
|
16
|
+
✅ **Character Development** - Programmatic character arcs, traits, motivations
|
|
17
|
+
✅ **Dialogue Mastery** - Natural speech, subtext, character voice
|
|
18
|
+
✅ **Screen Continuity** - Visual consistency rules (180-degree rule, match cuts)
|
|
19
|
+
✅ **Fountain Format** - Industry-standard plain-text screenplay markup
|
|
20
|
+
✅ **VS Code Integration** - Better Fountain extension support
|
|
21
|
+
✅ **Export Tools** - Final Draft (.fdx), PDF, HTML export
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
### With CLI (Recommended)
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
augx link writing-standards/screenplay
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Manual Setup
|
|
32
|
+
|
|
33
|
+
1. Copy `augment-extensions/writing-standards/screenplay/` to your project
|
|
34
|
+
2. Create `.augment/screenplay-config.json` with category selection
|
|
35
|
+
3. Reference rule files in your AI prompts
|
|
36
|
+
|
|
37
|
+
## Configuration
|
|
38
|
+
|
|
39
|
+
Create `.augment/screenplay-config.json`:
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"categories": ["aaa-hollywood-films"],
|
|
44
|
+
"universalRules": true,
|
|
45
|
+
"fountainFormat": true,
|
|
46
|
+
"exportFormats": ["fdx", "pdf"]
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Available Categories
|
|
51
|
+
|
|
52
|
+
1. **aaa-hollywood-films** - AAA Hollywood blockbusters
|
|
53
|
+
2. **independent-films** - Independent/art-house films
|
|
54
|
+
3. **tv-series** - Television series (episodic)
|
|
55
|
+
4. **web-content** - Web series and short-form content
|
|
56
|
+
5. **news-broadcasts** - News segments and broadcasts
|
|
57
|
+
6. **commercials** - Advertising and commercials
|
|
58
|
+
7. **streaming-content** - Streaming platform content
|
|
59
|
+
8. **live-tv-productions** - Live TV productions
|
|
60
|
+
|
|
61
|
+
## Directory Structure
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
augment-extensions/writing-standards/screenplay/
|
|
65
|
+
├── module.json # Module metadata
|
|
66
|
+
├── README.md # This file
|
|
67
|
+
├── rules/ # Screenplay writing rules
|
|
68
|
+
│ ├── universal-formatting.md # AMPAS formatting standards
|
|
69
|
+
│ ├── narrative-structures.md # Three-act, beat sheets, hero's journey
|
|
70
|
+
│ ├── character-development.md # Character arcs and development
|
|
71
|
+
│ ├── dialogue-writing.md # Dialogue best practices
|
|
72
|
+
│ ├── screen-continuity.md # Visual consistency rules
|
|
73
|
+
│ ├── pacing-timing.md # Pacing and timing guidelines
|
|
74
|
+
│ ├── diversity-inclusion.md # Diversity and inclusion standards
|
|
75
|
+
│ ├── aaa-hollywood-films.md # AAA Hollywood category rules
|
|
76
|
+
│ ├── independent-films.md # Independent film category rules
|
|
77
|
+
│ ├── tv-series.md # TV series category rules
|
|
78
|
+
│ ├── web-content.md # Web content category rules
|
|
79
|
+
│ ├── news-broadcasts.md # News broadcast category rules
|
|
80
|
+
│ ├── commercials.md # Commercial category rules
|
|
81
|
+
│ ├── streaming-content.md # Streaming content category rules
|
|
82
|
+
│ └── live-tv-productions.md # Live TV category rules
|
|
83
|
+
├── schemas/ # JSON schemas for screenplay data
|
|
84
|
+
│ ├── character-profile.json # Character profile schema
|
|
85
|
+
│ ├── beat-sheet.json # Beat sheet schema
|
|
86
|
+
│ ├── plot-outline.json # Plot outline schema
|
|
87
|
+
│ └── trope-inventory.json # Trope inventory schema
|
|
88
|
+
└── examples/ # Example screenplay files
|
|
89
|
+
├── aaa-hollywood-scene.fountain
|
|
90
|
+
├── independent-monologue.fountain
|
|
91
|
+
├── tv-episode-teaser.fountain
|
|
92
|
+
├── news-segment.fountain
|
|
93
|
+
├── commercial-30sec.fountain
|
|
94
|
+
├── character-profile-example.yaml
|
|
95
|
+
├── beat-sheet-example.yaml
|
|
96
|
+
└── plot-outline-example.yaml
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Core Guidelines
|
|
100
|
+
|
|
101
|
+
### Universal Formatting (AMPAS Standards)
|
|
102
|
+
|
|
103
|
+
- **Font**: 12-point Courier or Courier New
|
|
104
|
+
- **Margins**: 1-inch top/bottom/right, 1.5-inch left
|
|
105
|
+
- **Page Length**: ~1 page per minute of screen time
|
|
106
|
+
- **Scene Headings**: ALL CAPS, INT./EXT., location, time of day
|
|
107
|
+
- **Action**: Present tense, active voice, visual descriptions
|
|
108
|
+
- **Dialogue**: Character name centered, dialogue indented
|
|
109
|
+
- **Transitions**: RIGHT-ALIGNED (FADE IN:, CUT TO:, DISSOLVE TO:)
|
|
110
|
+
|
|
111
|
+
### Narrative Structures
|
|
112
|
+
|
|
113
|
+
1. **Three-Act Structure** (Syd Field)
|
|
114
|
+
- Act I: Setup (25% - pages 1-30)
|
|
115
|
+
- Act II: Confrontation (50% - pages 30-90)
|
|
116
|
+
- Act III: Resolution (25% - pages 90-120)
|
|
117
|
+
|
|
118
|
+
2. **Save the Cat Beat Sheet** (Blake Snyder)
|
|
119
|
+
- Opening Image, Theme Stated, Setup, Catalyst, Debate, Break into Two, B Story, Fun and Games, Midpoint, Bad Guys Close In, All Is Lost, Dark Night of the Soul, Break into Three, Finale, Final Image
|
|
120
|
+
|
|
121
|
+
3. **Hero's Journey** (Joseph Campbell)
|
|
122
|
+
- Ordinary World, Call to Adventure, Refusal, Meeting the Mentor, Crossing the Threshold, Tests/Allies/Enemies, Approach, Ordeal, Reward, The Road Back, Resurrection, Return with Elixir
|
|
123
|
+
|
|
124
|
+
### Character Development
|
|
125
|
+
|
|
126
|
+
- **Character Arc**: Transformation from beginning to end
|
|
127
|
+
- **Traits**: Physical, psychological, sociological
|
|
128
|
+
- **Motivations**: Internal and external goals
|
|
129
|
+
- **Relationships**: Protagonist, antagonist, allies, mentors
|
|
130
|
+
- **Dialogue Voice**: Unique speech patterns per character
|
|
131
|
+
|
|
132
|
+
## VS Code Integration
|
|
133
|
+
|
|
134
|
+
### Better Fountain Extension
|
|
135
|
+
|
|
136
|
+
1. Install: `ext install piersdeseilligny.betterfountain`
|
|
137
|
+
2. Open `.fountain` files for syntax highlighting
|
|
138
|
+
3. Use `Ctrl+Shift+P` → "Fountain: Export to PDF"
|
|
139
|
+
|
|
140
|
+
### Fountain Syntax
|
|
141
|
+
|
|
142
|
+
```fountain
|
|
143
|
+
INT. COFFEE SHOP - DAY
|
|
144
|
+
|
|
145
|
+
SARAH, 30s, sits alone with a laptop.
|
|
146
|
+
|
|
147
|
+
SARAH
|
|
148
|
+
(to herself)
|
|
149
|
+
This is it. The moment of truth.
|
|
150
|
+
|
|
151
|
+
She hits ENTER. Waits.
|
|
152
|
+
|
|
153
|
+
FADE OUT.
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Export Formats
|
|
157
|
+
|
|
158
|
+
### Final Draft (.fdx)
|
|
159
|
+
**Industry Standard** - Most widely used professional screenplay format
|
|
160
|
+
|
|
161
|
+
**Tools**:
|
|
162
|
+
- **Better Fountain** (VS Code): Export → Final Draft
|
|
163
|
+
- **Fountain CLI**: `fountain --fdx screenplay.fountain`
|
|
164
|
+
- **Highland 2**: Native Fountain support with FDX export
|
|
165
|
+
- **WriterDuet**: Import Fountain, export FDX
|
|
166
|
+
|
|
167
|
+
**Use Cases**:
|
|
168
|
+
- Professional submissions
|
|
169
|
+
- Studio collaboration
|
|
170
|
+
- Production scheduling
|
|
171
|
+
- Script breakdowns
|
|
172
|
+
|
|
173
|
+
### PDF
|
|
174
|
+
**Print-Ready** - Universal format for reading and distribution
|
|
175
|
+
|
|
176
|
+
**Tools**:
|
|
177
|
+
- **Better Fountain** (VS Code): `Ctrl+Shift+P` → "Fountain: Export to PDF"
|
|
178
|
+
- **Fountain CLI**: `fountain --pdf screenplay.fountain`
|
|
179
|
+
- **Highland 2**: Export → PDF
|
|
180
|
+
- **Wrap**: Online Fountain to PDF converter
|
|
181
|
+
|
|
182
|
+
**Formatting**:
|
|
183
|
+
- Industry-standard margins
|
|
184
|
+
- Courier 12pt font
|
|
185
|
+
- Page numbers
|
|
186
|
+
- Title page
|
|
187
|
+
- Proper scene numbering
|
|
188
|
+
|
|
189
|
+
**Use Cases**:
|
|
190
|
+
- Script distribution
|
|
191
|
+
- Table reads
|
|
192
|
+
- Submissions
|
|
193
|
+
- Archival
|
|
194
|
+
|
|
195
|
+
### HTML
|
|
196
|
+
**Web-Friendly** - For online viewing and sharing
|
|
197
|
+
|
|
198
|
+
**Tools**:
|
|
199
|
+
- **Better Fountain** (VS Code): Export → HTML
|
|
200
|
+
- **Fountain CLI**: `fountain --html screenplay.fountain`
|
|
201
|
+
- **Afterwriting**: Online Fountain editor with HTML export
|
|
202
|
+
|
|
203
|
+
**Features**:
|
|
204
|
+
- Responsive design
|
|
205
|
+
- Searchable text
|
|
206
|
+
- Hyperlinked scenes
|
|
207
|
+
- Mobile-friendly
|
|
208
|
+
- Easy sharing
|
|
209
|
+
|
|
210
|
+
**Use Cases**:
|
|
211
|
+
- Online portfolios
|
|
212
|
+
- Web publishing
|
|
213
|
+
- Collaborative review
|
|
214
|
+
- Mobile reading
|
|
215
|
+
|
|
216
|
+
### Conversion Workflow
|
|
217
|
+
|
|
218
|
+
**Fountain → Final Draft**:
|
|
219
|
+
```bash
|
|
220
|
+
# Using Better Fountain in VS Code
|
|
221
|
+
1. Open .fountain file
|
|
222
|
+
2. Ctrl+Shift+P
|
|
223
|
+
3. "Fountain: Export to Final Draft"
|
|
224
|
+
4. Save as .fdx
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**Fountain → PDF**:
|
|
228
|
+
```bash
|
|
229
|
+
# Using Better Fountain in VS Code
|
|
230
|
+
1. Open .fountain file
|
|
231
|
+
2. Ctrl+Shift+P
|
|
232
|
+
3. "Fountain: Export to PDF"
|
|
233
|
+
4. Configure settings (title page, scene numbers)
|
|
234
|
+
5. Save as .pdf
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
**Fountain → HTML**:
|
|
238
|
+
```bash
|
|
239
|
+
# Using Fountain CLI
|
|
240
|
+
fountain --html screenplay.fountain > screenplay.html
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Recommended Tools
|
|
244
|
+
|
|
245
|
+
**VS Code + Better Fountain** (Free):
|
|
246
|
+
- Syntax highlighting
|
|
247
|
+
- Live preview
|
|
248
|
+
- Export to PDF/FDX/HTML
|
|
249
|
+
- Autocomplete
|
|
250
|
+
- Snippet support
|
|
251
|
+
|
|
252
|
+
**Highland 2** ($50):
|
|
253
|
+
- Native Fountain support
|
|
254
|
+
- Professional export options
|
|
255
|
+
- Revision tracking
|
|
256
|
+
- Gender analysis
|
|
257
|
+
- Sprint mode
|
|
258
|
+
|
|
259
|
+
**WriterDuet** (Free/Pro):
|
|
260
|
+
- Real-time collaboration
|
|
261
|
+
- Cloud-based
|
|
262
|
+
- Import/export Fountain
|
|
263
|
+
- Mobile apps
|
|
264
|
+
- Version control
|
|
265
|
+
|
|
266
|
+
**Fade In** ($80):
|
|
267
|
+
- Professional screenwriting software
|
|
268
|
+
- Fountain import/export
|
|
269
|
+
- Production features
|
|
270
|
+
- Cross-platform
|
|
271
|
+
|
|
272
|
+
### Export Best Practices
|
|
273
|
+
|
|
274
|
+
**Before Exporting**:
|
|
275
|
+
- ✅ Spell check
|
|
276
|
+
- ✅ Verify scene headings
|
|
277
|
+
- ✅ Check character name consistency
|
|
278
|
+
- ✅ Review dialogue formatting
|
|
279
|
+
- ✅ Confirm page count
|
|
280
|
+
- ✅ Add title page
|
|
281
|
+
- ✅ Number scenes (if required)
|
|
282
|
+
|
|
283
|
+
**For Submissions**:
|
|
284
|
+
- Use PDF for most submissions
|
|
285
|
+
- Use FDX for production/collaboration
|
|
286
|
+
- Include title page with contact info
|
|
287
|
+
- Follow specific submission guidelines
|
|
288
|
+
- Verify file size limits
|
|
289
|
+
- Test file opens correctly
|
|
290
|
+
|
|
291
|
+
## References
|
|
292
|
+
|
|
293
|
+
- [AMPAS Nicholl Fellowship Requirements](https://www.oscars.org/nicholl/requirements)
|
|
294
|
+
- [Fountain Specification](https://fountain.io/)
|
|
295
|
+
- [Final Draft](https://www.finaldraft.com/)
|
|
296
|
+
- Syd Field: "Screenplay: The Foundations of Screenwriting"
|
|
297
|
+
- Blake Snyder: "Save the Cat!"
|
|
298
|
+
- Joseph Campbell: "The Hero with a Thousand Faces"
|
|
299
|
+
- Robert McKee: "Story"
|
|
300
|
+
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# Screenplay Rule Templates
|
|
2
|
+
|
|
3
|
+
This directory contains templates for creating genre, theme, and style rule files.
|
|
4
|
+
|
|
5
|
+
## Templates
|
|
6
|
+
|
|
7
|
+
### genre-template.md
|
|
8
|
+
|
|
9
|
+
Use this template when creating a new genre rule file. Each genre should include:
|
|
10
|
+
|
|
11
|
+
- **Core Rules**: 5-10 fundamental rules that define the genre
|
|
12
|
+
- **Guidelines**: 10-15 specific guidelines for structure, pacing, characters, tone, visuals, and dialogue
|
|
13
|
+
- **Common Pitfalls**: 3-5 mistakes to avoid
|
|
14
|
+
- **Film Examples**: 3-5 real films with specific scene references
|
|
15
|
+
- **Integration**: How the genre works with themes and styles
|
|
16
|
+
- **Best Practices**: 5+ actionable tips
|
|
17
|
+
|
|
18
|
+
**Target Depth Coverage**: 85%
|
|
19
|
+
|
|
20
|
+
### theme-template.md
|
|
21
|
+
|
|
22
|
+
Use this template when creating a new theme rule file. Each theme should include:
|
|
23
|
+
|
|
24
|
+
- **Core Rules**: 5-8 rules for thematic consistency
|
|
25
|
+
- **Integration Guidelines**: How to weave the theme through Acts I, II, and III
|
|
26
|
+
- **Character Connection**: How protagonist, antagonist, and supporting characters relate to the theme
|
|
27
|
+
- **Subtext Techniques**: How to convey theme through dialogue, visuals, and action
|
|
28
|
+
- **Film Examples**: 3-5 real films with specific thematic moments
|
|
29
|
+
- **Integration**: How the theme works with genres and styles
|
|
30
|
+
- **Best Practices**: 5+ actionable tips
|
|
31
|
+
|
|
32
|
+
**Target Depth Coverage**: 85%
|
|
33
|
+
|
|
34
|
+
### style-template.md
|
|
35
|
+
|
|
36
|
+
Use this template when creating a new narrative style rule file. Each style should include:
|
|
37
|
+
|
|
38
|
+
- **Structural Requirements**: 5-8 requirements specific to the style
|
|
39
|
+
- **Pacing Guidelines**: How to pace scenes and acts in this style
|
|
40
|
+
- **Visual Storytelling**: Camera work, visual motifs, action line approach
|
|
41
|
+
- **Dialogue Approach**: How dialogue functions in this style
|
|
42
|
+
- **Technical Formatting**: Special formatting considerations
|
|
43
|
+
- **Film Examples**: 3-5 real films with specific stylistic moments
|
|
44
|
+
- **Integration**: How the style works with genres and themes
|
|
45
|
+
- **Best Practices**: 5+ actionable tips
|
|
46
|
+
|
|
47
|
+
**Target Depth Coverage**: 85%
|
|
48
|
+
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
1. **Copy the appropriate template** to the target directory (genres/rules/, themes/rules/, or styles/rules/)
|
|
52
|
+
2. **Rename the file** to match the feature name (e.g., `action.md`, `redemption.md`, `non-linear.md`)
|
|
53
|
+
3. **Fill in all sections** following the template structure
|
|
54
|
+
4. **Include real film examples** with specific scenes or moments
|
|
55
|
+
5. **Ensure 85% depth coverage** by providing comprehensive, actionable content
|
|
56
|
+
6. **Update the parent module.json** to include the new rule file
|
|
57
|
+
|
|
58
|
+
## Quality Standards
|
|
59
|
+
|
|
60
|
+
### Depth Coverage (85% Target)
|
|
61
|
+
|
|
62
|
+
Each rule file should be comprehensive enough that an AI agent can:
|
|
63
|
+
- Understand the core concept completely
|
|
64
|
+
- Apply the rules consistently
|
|
65
|
+
- Identify violations or weak applications
|
|
66
|
+
- Provide specific, actionable feedback
|
|
67
|
+
- Reference real-world examples
|
|
68
|
+
|
|
69
|
+
### Film Examples
|
|
70
|
+
|
|
71
|
+
- **Minimum**: 3 film examples per rule file
|
|
72
|
+
- **Recommended**: 5 film examples per rule file
|
|
73
|
+
- **Requirements**:
|
|
74
|
+
- Include film title and year
|
|
75
|
+
- Name the director
|
|
76
|
+
- Describe specific scenes or moments (not just general references)
|
|
77
|
+
- Explain WHY the example works
|
|
78
|
+
- Identify specific techniques used
|
|
79
|
+
|
|
80
|
+
### Rules and Guidelines
|
|
81
|
+
|
|
82
|
+
- **Core Rules**: Must be specific, actionable, and enforceable
|
|
83
|
+
- **Guidelines**: Should provide practical advice for implementation
|
|
84
|
+
- **Examples**: Include both good (✅) and bad (❌) examples
|
|
85
|
+
- **Explanations**: Explain WHY each rule matters, not just WHAT it is
|
|
86
|
+
|
|
87
|
+
### AI Parsing
|
|
88
|
+
|
|
89
|
+
All rule files must be:
|
|
90
|
+
- **Structured**: Use consistent markdown formatting
|
|
91
|
+
- **Scannable**: Use clear headings and subheadings
|
|
92
|
+
- **Actionable**: Provide specific, implementable guidance
|
|
93
|
+
- **Comprehensive**: Cover all aspects of the feature
|
|
94
|
+
- **Referenced**: Include real-world examples
|
|
95
|
+
|
|
96
|
+
## Validation Checklist
|
|
97
|
+
|
|
98
|
+
Before submitting a new rule file, verify:
|
|
99
|
+
|
|
100
|
+
- [ ] All template sections are filled in
|
|
101
|
+
- [ ] 5-10 core rules provided (genres/styles) or 5-8 (themes)
|
|
102
|
+
- [ ] 10-15 guidelines provided (genres) or integration guidelines (themes/styles)
|
|
103
|
+
- [ ] 3-5 film examples with specific scenes
|
|
104
|
+
- [ ] Common pitfalls identified
|
|
105
|
+
- [ ] Best practices listed
|
|
106
|
+
- [ ] Integration with other features documented
|
|
107
|
+
- [ ] Depth coverage reaches 85%
|
|
108
|
+
- [ ] Markdown formatting is consistent
|
|
109
|
+
- [ ] No placeholder text remains
|
|
110
|
+
- [ ] File is saved in correct directory
|
|
111
|
+
- [ ] Parent module.json updated
|
|
112
|
+
|
|
113
|
+
## Character Count Guidelines
|
|
114
|
+
|
|
115
|
+
- **Small rule file**: < 5,000 characters
|
|
116
|
+
- **Medium rule file**: 5,000 - 10,000 characters
|
|
117
|
+
- **Large rule file**: 10,000 - 15,000 characters
|
|
118
|
+
- **Target**: 8,000 - 12,000 characters per rule file
|
|
119
|
+
|
|
120
|
+
This ensures comprehensive coverage while maintaining readability and AI parsing efficiency.
|
|
121
|
+
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# [Genre Name] Genre
|
|
2
|
+
|
|
3
|
+
**Category**: Screenplay Genre
|
|
4
|
+
**Type**: [Primary/Hybrid]
|
|
5
|
+
**Complexity**: [Low/Medium/High]
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
[Brief description of the genre - 2-3 sentences explaining what defines this genre]
|
|
10
|
+
|
|
11
|
+
## Core Concept
|
|
12
|
+
|
|
13
|
+
[Detailed explanation of the genre's fundamental characteristics and what makes it unique]
|
|
14
|
+
|
|
15
|
+
## Core Rules
|
|
16
|
+
|
|
17
|
+
### Rule 1: [Rule Name]
|
|
18
|
+
|
|
19
|
+
**Description**: [What this rule requires]
|
|
20
|
+
|
|
21
|
+
**Why It Matters**: [Explanation of why this rule is important to the genre]
|
|
22
|
+
|
|
23
|
+
**Examples**:
|
|
24
|
+
- ✅ **Good**: [Example demonstrating correct application]
|
|
25
|
+
- ❌ **Bad**: [Example demonstrating violation]
|
|
26
|
+
|
|
27
|
+
**Film Reference**: [Film title] - [Specific scene or moment that demonstrates this rule]
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
### Rule 2: [Rule Name]
|
|
32
|
+
|
|
33
|
+
[Repeat structure for 5-10 core rules]
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Guidelines
|
|
38
|
+
|
|
39
|
+
### Structure
|
|
40
|
+
|
|
41
|
+
- **Act I**: [Specific structural requirements for this genre in Act I]
|
|
42
|
+
- **Act II**: [Specific structural requirements for this genre in Act II]
|
|
43
|
+
- **Act III**: [Specific structural requirements for this genre in Act III]
|
|
44
|
+
|
|
45
|
+
### Pacing
|
|
46
|
+
|
|
47
|
+
- [Pacing guideline 1]
|
|
48
|
+
- [Pacing guideline 2]
|
|
49
|
+
- [Pacing guideline 3]
|
|
50
|
+
|
|
51
|
+
### Character Archetypes
|
|
52
|
+
|
|
53
|
+
- **Protagonist**: [Typical protagonist characteristics for this genre]
|
|
54
|
+
- **Antagonist**: [Typical antagonist characteristics for this genre]
|
|
55
|
+
- **Supporting**: [Common supporting character types]
|
|
56
|
+
|
|
57
|
+
### Tone and Atmosphere
|
|
58
|
+
|
|
59
|
+
- [Tone guideline 1]
|
|
60
|
+
- [Tone guideline 2]
|
|
61
|
+
- [Atmosphere considerations]
|
|
62
|
+
|
|
63
|
+
### Visual Style
|
|
64
|
+
|
|
65
|
+
- [Visual storytelling approach for this genre]
|
|
66
|
+
- [Common visual motifs]
|
|
67
|
+
- [Cinematography considerations]
|
|
68
|
+
|
|
69
|
+
### Dialogue
|
|
70
|
+
|
|
71
|
+
- [Dialogue style for this genre]
|
|
72
|
+
- [Common dialogue patterns]
|
|
73
|
+
- [What to avoid]
|
|
74
|
+
|
|
75
|
+
## Common Pitfalls
|
|
76
|
+
|
|
77
|
+
### Pitfall 1: [Pitfall Name]
|
|
78
|
+
|
|
79
|
+
**Problem**: [Description of the common mistake]
|
|
80
|
+
|
|
81
|
+
**Solution**: [How to avoid or fix this pitfall]
|
|
82
|
+
|
|
83
|
+
**Example**: [Brief example]
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### Pitfall 2: [Pitfall Name]
|
|
88
|
+
|
|
89
|
+
[Repeat for 3-5 common pitfalls]
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Film Examples
|
|
94
|
+
|
|
95
|
+
### Example 1: [Film Title] ([Year])
|
|
96
|
+
|
|
97
|
+
**Director**: [Director Name]
|
|
98
|
+
|
|
99
|
+
**Why It Works**: [Explanation of how this film exemplifies the genre]
|
|
100
|
+
|
|
101
|
+
**Key Scenes**:
|
|
102
|
+
- **[Scene Description]**: [What makes this scene a perfect genre example]
|
|
103
|
+
- **[Scene Description]**: [What makes this scene a perfect genre example]
|
|
104
|
+
|
|
105
|
+
**Techniques Used**:
|
|
106
|
+
- [Technique 1]
|
|
107
|
+
- [Technique 2]
|
|
108
|
+
- [Technique 3]
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
### Example 2: [Film Title] ([Year])
|
|
113
|
+
|
|
114
|
+
[Repeat for 3-5 film examples]
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Integration with Other Features
|
|
119
|
+
|
|
120
|
+
### Compatible Themes
|
|
121
|
+
|
|
122
|
+
- **[Theme Name]**: [How this theme works with this genre]
|
|
123
|
+
- **[Theme Name]**: [How this theme works with this genre]
|
|
124
|
+
|
|
125
|
+
### Compatible Styles
|
|
126
|
+
|
|
127
|
+
- **[Style Name]**: [How this style works with this genre]
|
|
128
|
+
- **[Style Name]**: [How this style works with this genre]
|
|
129
|
+
|
|
130
|
+
### Hybrid Combinations
|
|
131
|
+
|
|
132
|
+
- **[Genre] + [This Genre]**: [How these genres combine effectively]
|
|
133
|
+
|
|
134
|
+
## Best Practices
|
|
135
|
+
|
|
136
|
+
1. [Best practice 1]
|
|
137
|
+
2. [Best practice 2]
|
|
138
|
+
3. [Best practice 3]
|
|
139
|
+
4. [Best practice 4]
|
|
140
|
+
5. [Best practice 5]
|
|
141
|
+
|
|
142
|
+
## Resources
|
|
143
|
+
|
|
144
|
+
- [Resource 1: Book, article, or reference]
|
|
145
|
+
- [Resource 2: Book, article, or reference]
|
|
146
|
+
- [Resource 3: Book, article, or reference]
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
**Depth Coverage**: 85%
|
|
151
|
+
**Last Updated**: [Date]
|
|
152
|
+
**Version**: 1.0.0
|
|
153
|
+
|