fountainview 1.0.5

  • Readme
  • Changelog
  • Example
  • Installing
  • 42

Flutter Fountain View #

FountainView is a Flutter plugin used for displaying Fountain screenplay documents. It takes a single string and displays the formatted document in a widget.

This Flutter Plugin is created using the Xamarin library FountainSharp written in F#.

This is possible with the use of Embeddinator-4000 which allows the creation of native libraries from Xamarin .NET libraries. The native Android (.aar) and iOS (Framework) is then embedded in a Flutter Plugin that can then be reused in any Flutter application.

For example, the Big Fish sample fountain doc looks like this when rendered. image info

Usage #

Usage is very straight forward, simply construct a new FountainView widget and provide it with a string containing valid Fountain Markup text.

new FountainView(fountainText)

The text will be parsed and converted to HTML and displayed as using the flutter_html plugin.

Note I plan to switch to the recently released official webview_flutter once it is stable.

Known Issues #

If you get the following error on Android

 No assemblies found in '(null)' or '<unavailable>'. Assuming this is part of Fast Deployment.

Open the build.gradle file under android/app/ and add the follow config inside android {}

aaptOptions {
    noCompress 'dll'
}

Acknowledgments #

This plugin is made using FountainSharp with thanks to Bryan Costanich.

FountainSharp is an F# based Fountain Markdown processor for use via .NET/Xamarin projects.

1.0.1 #

  • First stable release

0.0.1 #

  • Initial published draft

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:fountainview/fountainview.dart';

void main()
{
  runApp(MaterialApp(
    title: "FountainView Example",
    home: MyApp()
  ));
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
          title: const Text('FountainView example app'),
        ),
        body: new FountainView("Title: Big Fish\nCredit: written by\nAuthor: John August\nSource: based on the novel by Daniel Wallace\nNotes:\t\n\tFINAL PRODUCTION DRAFT\n\tincludes post-production dialogue \n\tand omitted scenes\nCopyright: (c) 2003 Columbia Pictures\n\nThis is a Southern story, full of lies and fabrications, but truer for their inclusion.\n\n====\n\n**FADE IN:**\n\nA RIVER.\n\nWe're underwater, watching a fat catfish swim along.  \n\nThis is The Beast.\n\nEDWARD (V.O.)\nThere are some fish that cannot be caught.  It's not that they're faster or stronger than other fish.  They're just touched by something extra.  Call it luck.  Call it grace.  One such fish was The Beast.  \n\nThe Beast's journey takes it past a dangling fish hook, baited with worms.  Past a tempting lure, sparkling in the sun.  Past a swiping bear claw.  The Beast isn't worried.\n\nEDWARD (V.O.)(CONT'D)\nBy the time I was born, he was already a legend.  He'd taken more hundred-dollar lures than any fish in Alabama. Some said that fish was the ghost of Henry Walls, a thief who'd drowned in that river 60 years before.   Others claimed he was a lesser dinosaur, left over from the Cretaceous period.\n\nINT.  WILL'S BEDROOM - NIGHT (1973)\n\nWILL BLOOM, AGE 3, listens wide-eyed as his father EDWARD BLOOM, 40's and handsome, tells the story.  In every gesture, Edward is bigger than life, describing each detail with absolute conviction.\n\nEDWARD\nI didn't put any stock into such speculation or superstition.  All I knew was I'd been trying to catch that fish since I was a boy no bigger than you.  \n(closer)\nAnd on the day you were born, that was the day I finally caught him.\n\nEXT.  CAMPFIRE - NIGHT (1977)\n\nA few years later, and Will sits with the other INDIAN GUIDES as Edward continues telling the story to the tribe.  \n\nEDWARD\nNow, I'd tried everything on it:  worms, lures, peanut butter, peanut butter-and-cheese.  But on that day I had a revelation:  if that fish was the ghost of a thief, the usual bait wasn't going to work.  I would have to use something he truly desired. \n\nEdward points to his wedding band, glinting in the firelight.\n\nLITTLE BRAVE\n(confused)\nYour finger?\n\nEdward slips his ring off.\n\nEDWARD\nGold."),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  fountainview: ^1.0.5

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:fountainview/fountainview.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
58
Overall:
Weighted score of the above. [more]
42
Learn more about scoring.

We analyzed this package on Apr 1, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://github.com/xamarin/mobcat/tree/FountainView/scratch/flutter/FountainView was unreachable.

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (flutter_html).

Package is getting outdated. (-11.51 points)

The package was last published 58 weeks ago.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
flutter_html ^0.9.4 0.9.9 0.11.1
Transitive dependencies
charcode 1.1.3
collection 1.14.11 1.14.12
csslib 0.16.1
html 0.14.0+3
meta 1.1.8
path 1.6.4
sky_engine 0.0.99
source_span 1.7.0
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8