scripttool/index.html at main · rsdoiel/scripttool · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>scripttools</title>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
</ul>
</nav>
<section>
<p><a href="https://www.repostatus.org/#active"><img
src="https://www.repostatus.org/badges/latest/active.svg"
alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /></a></p>
<p><a href="https://snapcraft.io/scripttool"><img
src="https://snapcraft.io/static/images/badges/en/snap-store-white.svg"
alt="Get it from the Snap Store" /></a></p>
<h1 id="scripttool">scripttool</h1>
<p>A tool for working with screenplay file formats (e.g. fdx, fountain,
osf, FadeIn).</p>
<h2 id="converting-to-fountain-format">Converting to fountain
format</h2>
<p>Convert from <em>screenplay.fdx</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code>    scripttool fdx2fountain screenplay.fdx screenplay.fountain</code></pre>
<p>Convert from <em>screenplay.fadein</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code>    scripttool fadein2fountain screenplay.fadein screenplay.fountain</code></pre>
<p>Convert from <em>screenplay.osf</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code>    scripttool osf2fountain screenplay.osf screenplay.fountain</code></pre>
<h2 id="working-with-fountain-files">Working with fountain files</h2>
<p>Pretty print fountain files</p>
<pre class="shell"><code>    scripttool fountainfmt screenplay.fountain</code></pre>
<p>Render a fountain file as JSON</p>
<pre class="shell"><code>    scripttool fountain2json screenplay.fountain</code></pre>
<h2 id="convert-from-fountain-format">Convert from fountain format</h2>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.fdx</em></p>
<pre class="shell"><code>    scripttool fountain2fdx screenplay.fountain screenplay.fdx</code></pre>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.fadein</em></p>
<pre class="shell"><code>    scripttool fountain2fadein screenplay.fountain screenplay.fadein</code></pre>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.osf</em></p>
<pre class="shell"><code>    scripttool fountain2osf screenplay.fountain screenplay.osf</code></pre>
<h2 id="script-reports">Script Reports</h2>
<p>NOTE: Currently only fountain documents are supported for reporting.
Currently the character list report is implemented as a proof of
concept.</p>
<p>List the characters in <em>screenplay.fountain</em></p>
<pre class="shell"><code>    scripttool characters screenplay.fountain</code></pre>
</section>
</body>
</html>