{"id":13750999,"url":"https://github.com/tin2tin/Blender_Screenwriter","last_synced_at":"2025-05-09T17:33:18.458Z","repository":{"id":41967250,"uuid":"220810103","full_name":"tin2tin/Blender_Screenwriter","owner":"tin2tin","description":"Blender add-on for writing screenplays and convert them directly into 3d scenes with assets and also into timed vse strips.","archived":false,"fork":false,"pushed_at":"2025-03-09T07:52:28.000Z","size":9654,"stargazers_count":198,"open_issues_count":3,"forks_count":20,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-09T08:25:54.382Z","etag":null,"topics":["addon","animatic","blender","blender-addon","film","movie","previz","screenplay","storyboard","writing"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tin2tin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-10T15:33:26.000Z","updated_at":"2025-03-09T07:52:31.000Z","dependencies_parsed_at":"2025-01-13T04:24:57.992Z","dependency_job_id":"f77b3bf8-1f7f-49e8-a4e8-0fd3ce3370fb","html_url":"https://github.com/tin2tin/Blender_Screenwriter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tin2tin%2FBlender_Screenwriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tin2tin%2FBlender_Screenwriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tin2tin%2FBlender_Screenwriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tin2tin%2FBlender_Screenwriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tin2tin","download_url":"https://codeload.github.com/tin2tin/Blender_Screenwriter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253295837,"owners_count":21885708,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addon","animatic","blender","blender-addon","film","movie","previz","screenplay","storyboard","writing"],"created_at":"2024-08-03T09:00:24.939Z","updated_at":"2025-05-09T17:33:17.509Z","avatar_url":"https://github.com/tin2tin.png","language":"Python","funding_links":[],"categories":["🔮Add-ons [^](#table)","Modeling, Sculpting \u0026 Texturing"],"sub_categories":["🪀Misc [^](#table)","Blender: Plugins \u0026 Addons"],"readme":"[\u003cimg src=\"https://img.shields.io/badge/Discord%20-%20Invite\"\u003e](https://discord.gg/HMYpnPzbTm) ![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/tintwotin)\n\n# Blender Screenwriter \u0026 Screenplayer\nScreenwriter and automatic previz/animatic generation. \n\n### Demo of Main Features\n[![Img alt text](https://github.com/tin2tin/Blender_Screenwriter/blob/master/yt_thumb.jpg?raw=true)](https://www.youtube.com/watch?v=KIqQH_e8Hs4)\n\n![](bsw_tut.gif)\n\n### Features\n\n## Screenwriter\n- Write screenplays in Blender Text Editor.\n- Get live preview of screenplay formatting.\n- Use the simple fountain markup syntax.\n- Open as Fountain.\n- Save as Fountain.\n- Change font(for preview).\n- Insert Title Page.\n- Insert scene numbers.\n- Correct caps.\n- Insert [[SHOT: ]] note/comment - will generate a camera in the scene. \n- \"\u003emy action\u003c\" will center action.\n- \"\u003e\" will force transition.\n- \"@\" will force character(may not be supported by all fountain parsers).\n- \".\" will force scene header.\n- Export to pdf.\n- Export to fdx(Final Draft).\n- Export to Html.\n\n## Screenplayer\n- Script to Screen sequence generation.\n- Assign 3d objects to screenplay keywords.\n- Extract screenplay data and timings.\n- Create a sequence with scene headings, action and dialogue as timed text strips.\n- Generate scenes for each screenplay scene.\n- Populated scenes with 3d objects assigned to words in the screenplay scene, where the words appear.\n- If more cameras are assigned to a scene, scene strips pointing to cameras and a multicam strip will be added to the master edit.\n- Generate cameras for each [[SHOT: ]] note/comment in the scenes where they appear. \n- Switch to the 3d scene based on the position of the screenplay scene.\n- Switch back to the master edit scene.\n\n\n## Mindmap\n- Generate and return mindmap if the Mindmap add-on is installed: \nhttps://github.com/SpectralVectors/MindMapper\n\nhttps://user-images.githubusercontent.com/1322593/234814066-7fe80ded-161d-4cd0-804a-e5300ce6ac67.mp4\n\n### How to Install\n\nUse Blender 2.82 Beta or higher.\n\nDownload the repository as zip and use the normal Blender installation procedure.\n\nIn the Text Editor Sidebar you'll find the Screenwriting buttons. They'll be disabled until you save a text-block with a .fountain extention or open .fountain a file. \n\nTo export the Screenplain[PDF] module https://github.com/vilcans/screenplain is needed. It should install automatic, but if installation fails on GNU/Linux, it can be installed with 2 commands in the terminal:\n* '/INSTALLED_BLENDER_PATH/2.81/python/bin/python3.7m' -m ensurepip\n* '/INSTALLED_BLENDER_PATH/2.81/python/bin/python3.7m' -m pip install screenplain[PDF]\n\nAlternatively this add-on can be used for module installation in Blender: https://github.com/amb/blender_pip/releases\n\n### Test Screenplay Files\nhttps://fountain.io/_downloads/Big%20Fish.fountain\n\nhttps://fountain.io/_downloads/Brick%20\u0026%20Steel.fountain\n\nhttps://fountain.io/_downloads/The%20Last%20Birthday%20Card.fountain\n\n### Fountain Syntax\nhttps://github.com/derickc/Fountainhead#fountain-syntax\n\nFor a complete overview of the Fountain syntax, go to [http://fountain.io/syntax](http://fountain.io/syntax).\n\n#### Scene Headings\nTo indicate a new scene, start a new line and type the location of the scene in all caps. For example:\n\n    INT. COFFEE SHOP - DAY\n\n#### Action\nThis is where you describe what is happening in the scene. Start a new line and type your action description in plain text. For example:\n\n    John walks into the coffee shop and orders a latte.\n\n#### Dialogue\nTo indicate dialogue, start a new line and type the character's name in all caps, followed by a period. Then, type the dialogue in plain text. For example:\n\n    JOHN\n    Can I get a latte, please?\n\n#### Parentheticals\nIf you need to indicate how a line of dialogue is spoken, you can use a parenthetical. Start a new line and type the character's name in all caps, followed by a period. Then, type the parenthetical in parentheses, followed by the dialogue in plain text. For example:\n\n    JOHN\n    (sarcastic)\n    Great, just what I needed.\n\n#### Transitions \nTo indicate a transition between scenes, start a new line and type the transition in all caps. For example:\n\n    CUT TO:\n\n#### Title Page \nThe Title Page holds metadata by Key Value pairs that are separated by `:` \n*Each key can have multiple values by placing them on newlines that are indented 3+ spaces or by a tab*\n\nFountain Element | Example\n--------------|---------------\nTitle: | `Title:` **Title**\nCredit: | `Credit:` **Written by**\nAuthor: | `Author:` **Author Name(s)**\nSource: | `Source:` **Story by...**\nDraft date: | `Draft date:` **Date**\nContact: | `Contact:` **Contact Info**\n\nAfter dropping to enters the Title Page is followed by the sceenplay elements.\n\nNot all of the following Fountain options are implemented in Blender Screenwriter or the export parsers used.\n\nFountain Element | Example\n--------------|---------------\nSections | One `#` or more at the start of the line\n\"Act\" Section | `#` at start of the line defines a **Act** section\n\"Sequence\" Section | `##` at start of the line defines a **Sequence** section\n\"Scene\" Section | `###` at start of the line defines a **Scene** section\nScene Headings | `.` at start of the line forces a Scene Heading. Using `INT.`, `EXT.`, `EST.`, `INT./EXT.`, `INT/EXT`, `I/E` at start of line interprets it also as a Scene Heading\nScene Numbers | `#`**Scene Number**`#` at the END of the Scene Heading\nAction | `!` at start of the line forces Action or have a paragraph of text with an empty line before and after it \nCharacter | `@` at start of the line forces Character even for characters with lowercase letter or an all uppercase line with empty line before and no empty line after\nCharacter Extensions | `(`**O.S., V.O., CONT'D**`)` at the END of the Character line \nParenthetical | Lines of `(`**Parenthetical Text**`)` that are beneath Character or Dialogue lines\nDialogue | Lines of text that are beneath Character or Parenthetical lines\nDual Dialogue | `^` at the END of the SECOND Character line \nLyrics | `~` at the start of the line\nTransitions | `\u003e` at start of the line forces a Transition or use `FADE IN:`, `FADE OUT.`, `FADE TO BLACK.`, alternatively an all uppercase line that ends with: `TO:`\n\nComments in the screenplay\nFountain Element | Example or Definition | Explanation\n--------------|---------------|---------------\nSynopses | Start line with: `=` | invisible text intended as writing aid for metadata\nNotes | `[[`**Note Text**`]]` | invisible text intended for external stakeholders\nBoneyard | `/*`**Boneyard Text**`*/` | invisible text intended for writer\n\nStyling of sceenplay text\nFountain Element | Example or Definition | Explanation\n--------------|---------------|---------------\nCentered Text | `\u003e`**Centered Text**`\u003c` | -\nPage Breaks | `===` | Line that only contains three or more consecutive equal signs: \nLine Breaks | \\r\\n | Lines can be broken up by using carriage returns\nItalics | `*`*Italic Text*`*` |-\nBold | `**`**Bold Text**`**` |-\nBold Italics | `***`***Bold Italic Text***`***` | -\nUnderline | `_`**Underline Text**`_` | Differs from markdown by not being strikethrough\n\\* | `\\*` | Special characters can be escaped by prefixing them with a \\ \n\n\nFountain example:\n\n```\nTitle:\n    Title 1\n    Title 2\nCredit: Written by\nAuthor: Author name\nSource: Story by...\nDraft date: 12/10/2014\nContact:\n    Contact Info\n    Address Line 1\n    Address Line 2\n\n# Act 1\n\n= The introduction of Character\n\nEXT. HOUSE - DAY\n\nSome action text.\n\nCHARACTER\n(parenthetical)\nDialogue.\n\nCUT TO:\n\n.Scene Heading\n```\n\n### More Blender Screenwriter utility add-ons\n\nAdd searchable markers for outlining and navigating the text:\nhttps://github.com/tin2tin/TextMarker-blender-addon\n\nAdding markers and writing timed script into the 3D View:\nhttps://github.com/philippe-lavoie/blender-fountain-addon\n\nSwitch cameras in 3D View from Sequencer:\nhttps://github.com/tin2tin/scene_strip_tools\n\nSwitch to the scene of the Scene strip:\nhttps://github.com/tin2tin/VSESwitchToScene\n\nLink text from TExt strip to text in 3D View:\nhttps://github.com/gabrielmontagne/blender-addon-link-text-to-vse-subtitle\n\nSplit text to node editor frames:\nhttps://github.com/gabrielmontagne/blender-addon-split-frame-from-text\n\nLink text to node editor frames:\nhttps://github.com/gabrielmontagne/blender-addon-link-text-to-frame\n\n\n\n### About\n\nThis add-on utilizes a fountain script parser, which converts .fountain files to python object. The Fountain screenplay format is by Nima Yousefi \u0026 John August; original code for Objective-C at https://github.com/nyousefi/Fountain. It is ported to Python 3 by Colton J. Provias, improved by Manuel Senfft https://github.com/Tagirijus/fountain. The Screenplain module by Martin Vilcans is used for exports https://github.com/vilcans/screenplain. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftin2tin%2FBlender_Screenwriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftin2tin%2FBlender_Screenwriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftin2tin%2FBlender_Screenwriter/lists"}