Ghostwood

User Tools

Site Tools

Trace:
sf_code

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
sf_code [2025/01/08 03:56] – jeffdsf_code [2025/01/08 22:42] (current) – jeffd
Line 3: Line 3:
 SF (Stefano) is our language for writing scenes.  Using a simple set of rules, it mimics the way a standard screenplay is written. SF (Stefano) is our language for writing scenes.  Using a simple set of rules, it mimics the way a standard screenplay is written.
  
-There is a proper spacing style, but the parser only cares whether or not some amount of space is present.  Here's the breakdown:+This isn't the only language you should use while writing a game using Ghostwood, but it is the language we recommend for writing the Scenes of Action and Dialogue between characters.
  
------- +See: [[SF Code Syntax]]
- +
-==== Script Title ==== +
-<code> +
-                         TITLE +
-                         ----- +
-</code> +
- +
-A Script Title is the first item on the Title Page of a script.  It should be indented with at least one whitespace.  The following line should consist of some white space followed by only hyphens (any number of them, but the intention is to underline the title.)  After this pattern has been completed, the parser is in **Title Page Context**, but additional lines of the Script Title may be present, each of which needs a corresponding hyphen line underneath it. +
- +
-=== Subtitle === +
- +
-==== Script Title ==== +
- +
-<code> +
-                         TITLE +
-                         ----- +
- +
-                     Subtitle Line 1 +
- +
-                 Additional Subtitle Line +
-</code> +
- +
- +
-Subtitle lines are any indented lines following the Script Title, and may begin with or include between them single blank lines.  Once two or more blank lines in a row are encountered, the total number of blank lines becomes temporary value X, the parser switches to **Title Page Credit Context**. +
- +
-=== Title Page Credit === +
- +
-<code> +
- +
- +
-                        Written by +
- +
- +
-                         Jeff Day +
- +
-                            & +
- +
-                       Patrick Neil +
-</code> +
- +
-A Title Page Credit has at least two blank lines before it.  The next line is indented and contains the description of the role.  It is followed by any number of blank lines, which are counted and become temporary value Y. +
- +
-Next are credited names assigned to the role.  There may also be throw-away lines containing "&" or "and"  the amount of blank lines between each credited name (or throw-away line) may be less than or equal to "Y", and if non-zero, the highest such value should become temporary value Z. +
- +
-If Y=Z, once the blank line counter is greater than Y, the next non-blank indented line begins a new **Title Page Credit**. +
- +
-If Z has been established, and Y < Z, and the blank line counter is greater OR EQUAL to Y, the next non-blank indented line begins a new **Title Page Credit**.  If the blank line counter becomes greater than X and greater than Y, the context switches to **Title Page Footer**.+
  
 ----- -----
  
-=== Title Page Footer === +When SF Code is processed one of the primary tasks of the processor is to identify Locations and Characters.
- +
-Any amount of additional indented or unindented text, including single or double blank lines, and including lines beginning with parenthesis, become the Title Page Footer.  Indented lines will be treated as right-aligned (such as the name and date of a particular script edition or draft.)  Unindented lines will be treated as left aligned (such as copyright and legal notices.) +
- +
-=== End of Title Page === +
- +
-The first line that begins with a non-parenthesis, non-ampersand, and non-alphanumeric symbol, and optionally containing other material, is the final line of the Title Page. +
- +
------ +
- +
-===== Left Margin (Scene Numbers or Labels) ===== +
- +
-Any text on the left margin is considered a Scene Number or Scene Label.  A scene number or label ends with a period.  Any special context (such as Dialogue Context) that was previously active is suspended as soon as a new Scene Number or Label is encountered. +
- +
-In proper indentation, this is at column zero. +
- +
-<code> +
-1.        EXT. COURTHOUSE +
-</code> +
- +
------ +
- +
-===== Indented Content ===== +
- +
-All regular content has at least one space of indentation preceding it. +
- +
-==== Page Number ==== +
- +
-<code> +
-                                                       2. +
-</code> +
- +
-A number, higher than 1, with a period.  Any special context (such as Dialogue Context) that was previously active is suspended as soon as a new Scene Number or Label is encountered. +
- +
-In proper indentation, this is at column 65 or higher (right-aligned.) +
- +
------ +
- +
-==== Scene Heading, Sub-Header, or Shot ==== +
- +
-<code> +
-1.        EXT. COURTHOUSE +
-</code> +
- +
-ALL UPPERCASE.  Can continue onto additional space-indented lines if needed, as long as it remains in ALL UPPERCASE, and whether one or more than one line, may optionally terminate with a colon or period to move into a jointly-expressed action (see Action.) +
- +
-Once specified, the Scene Heading, Sub-Header, or Shot, including the optional jointly-expressed action, is always followed by a blank line. +
- +
-If the text begins with either INT. or EXT, or INT/EXT. or EXT/INT.. it is a Scene Heading, otherwise it is a Sub-Header or Shot: +
- +
-<code> +
-          HALLWAY +
-</code> +
- +
-Sub-Headers and Shots are used for moving between locations, camera angles, or points of view, in the same scene. +
- +
-In proper indentation, this is at column 10. +
- +
-=== Action === +
- +
-<code> +
- +
-          The room is dimly lit with only a flickering candle. +
-</code> +
- +
-Mixed case. When not jointly expressed with a Scene Heading, Sub-Header, or Shot, it always follows after a blank line. +
- +
-In proper indentation, this is at column 10. +
- +
-When combined with a Section Heading, there is no blank line before it, and it looks like this: +
- +
-<code> +
-1.        EXT. COURTHOUSE - NIGHT:  Rain is falling. +
-</code> +
- +
-As this continues after a Scene Heading, there is no associated indentation. +
- +
------ +
- +
-==== Character ==== +
- +
-<code> +
-                              PHILIP MARLOWE (V.O.) +
-                         (speaking in a whisper) +
-</code> +
- +
-Always follows after a blank line.  Uppercase, but may optionally be followed by an extension in parenthesis.  The following line will never be blank, which is what differentiates this from a Sub-header or Shot designator.  Once a Character has been specified, we are in **Dialogue Context** up until the next blank line or page number. +
- +
-In proper indentation, this is at column 30. +
- +
-=== Parenthetical === +
- +
-<code> +
-                              PHILIP MARLOWE (V.O.) +
-                         (speaking in a whisper) +
-</code> +
- +
-Part of the **Dialogue Context** only.  May cross multiple lines, but always begins with an open parenthesis as the first non-space character on the line. +
- +
-In proper indentation, this is at column 25. +
- +
-=== Dialogue === +
- +
-<code> +
-                              PHILIP MARLOWE +
-                    Of all the office doors in all the back +
-                    alleys of all of west L. A., what +
-                    makes a broad like you come waltzing +
-                    into mine? +
-</code> +
- +
-Part of the **Dialogue Context** only.  May cross multiple lines.  Mixed case. +
- +
-In proper indentation, this is at column 20.  Dialogue should be a maximum of about 32 characters per line. +
- +
------ +
- +
-==== Introduction of Quoted Material ==== +
- +
-Any mixed-case line ending in a colon.  After this, we may optionally have blank lines or a page break and page number, but if the next substantive line begins with a quotation mark we then enter **Quoted Material Context**. +
- +
-<code> +
-          The sign reads: +
- +
-                             "Philip Marlowe, +
-</code> +
- +
-In proper indentation, this introduction is at column 10, +
- +
-=== Quoted Material === +
- +
-While in **Quoted Material Context**, all lines are considered part of the Quoted Material. +
- +
-**Quoted Material Context** remains open until a line ends with a colon, or ends with punctuation including a colon, unless suspended by a page break (or another page break), or by a Scene Number or Label. +
- +
-<code> +
-                            "Philip Marlowe, +
-                         Private Investigator." +
-</code> +
- +
-In proper indentation, the quoted content is indented, usually at least as much as Dialogue, but may be centered or aligned as appropriate for the quoted content itself. +
- +
------ +
- +
-==== Transition ==== +
- +
-All uppercase followed by a colon, such as "CUT TO:", or all uppercase enclosed in parenthesis, such as "(CONTINUED)". This is allowed within or outside of **Dialogue Context** or **Quoted Material Context**. +
- +
-<code> +
-                                                       (CONTINUED) +
-</code> +
- +
- +
-In proper indentation, this is at column 55. +
- +
-==== Intercut ==== +
- +
-There are two ways of specifying an intercut.  The first is simply a Scene-Heading, Sub-Header, or Shot which includes the word INTERCUT or INTERCUT BETWEEN in it.  When this is done, a slash is often used to designate who or what is being Intercut between. +
- +
-<code> +
- +
-          INTERCUT PHILIP MARLOWE / MOTEL OWNER +
-</code> +
- +
-Intercut may also be achieved as a Transition reading "INTERCUT" or "INTERCUT WITH" followed by a colon, and having the the new SHOT or subject specified on the following line(s).  The INTERCUT transition will be indented as a transition, and the SCENE HEADING, SUB-HEADER, SHOT or CHARACTER will be indented as usual (column 20 for CHARACTER introducing a **Dialogue Context** and 10 for all others.) +
- +
-===== Outlying Concerns ===== +
- +
-<code> +
-Mixed caps:  A THING. +
-(followed by blank line) +
-</code> +
- +
-In the above case, "A THING." is just considered part of the described action.+
  
-<code> +INT. "JOE'S BAR"/KITCHEN (1920) - NIGHT (LATER)
-Mixed caps.  A THING: +
-(continues parsing as a normal transition) +
-</code>+
  
-<code> +EXT. LUMBERDALE HIGH SCHOOL/FOOTBALL FIELD - DAY
-Mixed caps:  A THING: +
-(continues parsing as a normal transition) +
-</code>+
  
-<code> +When a slash is used, it divides a primary location from a sub area which is part of or within the main area.  Once the main area hsa been established, you can use sub-headers (without INT. or EXT.) to transition to other sub-areas within the same main area as part of the same scene.
-Mixed caps.  (A THING) +
-(continues parsing as a normal transition) +
-</code>+
  
-<code> 
-Mixed caps:  (A THING) 
-(continues parsing as a normal transition) 
-</code> 
  
-In the above four cases, "A THING:" becomes a Transition.  As long as the last non-whitespace character on the line is a colon, or the entire ending phrase of the line was an UPPERCASE in parenthesis, parsing continues as if it was a stand-alone transition on a line by itself. 
sf_code.1736337370.txt.gz · Last modified: 2025/01/08 03:56 by jeffd
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki