README
¶
{
"title": "scripttool, a program for converting screen play formats"
}
scripttool
A tool for working with screenplay file formats (e.g. fdx, fountain)
Converting formats
Convert from screenplay.fdx to screenplay.fountain
scripttool fdx2fountain screenplay.fdx screenplay.fountain
Convert from screenplay.fadein to screenplay.fountain
scripttool fadein2fountain screenplay.fadein screenplay.fountain
Convert from screenplay.fountain to screenplay.osf
scripttool fountain2osf screenplay.foutain screenplay.osf
Script Reports
This is still in the planning stage. List the characters in screenplay.fdx
scripttool characters screenplay.fdx
Documentation
¶
Overview ¶
scripttool is a package focused on converting to/from different file formats used in working with scripts,screenplays and other creative writing.
@author R. S. Doiel, <rsdoiel@gmail.com>
BSD 2-Clause License ¶
Copyright (c) 2021, R. S. Doiel All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
scripttool is a package focused on converting to/from different file formats used in working with scripts,screenplays and other creative writing.
@author R. S. Doiel, <rsdoiel@gmail.com>
BSD 2-Clause License ¶
Copyright (c) 2021, R. S. Doiel All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Index ¶
- Constants
- func CharacterList(in io.Reader, out io.Writer) error
- func FadeInToFountain(inputFName string, out io.Writer) error
- func FdxToFountain(in io.Reader, out io.Writer) error
- func FountainFmt(in io.Reader, out io.Writer) error
- func FountainToFadeIn(in io.Reader, outFName string) error
- func FountainToFdx(in io.Reader, out io.Writer) error
- func FountainToFountain(in io.Reader, out io.Writer) error
- func FountainToHTML(in io.Reader, out io.Writer) error
- func FountainToJSON(in io.Reader, out io.Writer) error
- func FountainToOSF(in io.Reader, out io.Writer) error
- func OSFToFountain(in io.Reader, out io.Writer) error
Constants ¶
const (
Version = `v0.0.5`
)
Variables ¶
This section is empty.
Functions ¶
func CharacterList ¶
CharacterList lists character in a screenplay
func FadeInToFountain ¶
FadeInToFountain converts the input buffer from .fadein to .fountain format.
func FdxToFountain ¶
FdxToFountain converts the an input buffer from .fdx to a .fountain format.
func FountainFmt ¶ added in v0.0.5
FountainFmt pretty prints a fountain document, optionally passing on sections, synopsis and notes.
func FountainToFadeIn ¶
FountainToFadeIn converts an input buffer in .fountain format to output buffer in .fadein
func FountainToFdx ¶
Fountain2Fdx converts an input buffer in .fountain format to output buffer in .fdx
func FountainToFountain ¶
Fountain2Fountain reads a input buffer as .fountain and pretty prints output as .fountain
func FountainToHTML ¶ added in v0.0.5
FountainToHTML takes a fountain script and formats it in the fountain scrippets HTML markup that can be used with the scrippets CSS, see https://fountain.io/scrippets and https://johnaugust.com/2004/screenbox. FIXME: Write wrapping functioHTMLon and add appropriate writer method to fountain package.
func FountainToJSON ¶ added in v0.0.5
FountainToJSON convert .fountain file to JSON
func FountainToOSF ¶
FountainToOSF converts an input buffer in .fountain format to output buffer in .osf
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
scripttool
scripttool is a tool for working with screenplay file formats.
|
scripttool is a tool for working with screenplay file formats. |