Lightspark is an open source Flash player implementation for playing
files in SWF format. Lightspark can run as a web browser plugin or as
a standalone application.

Lightspark supports SWF files written on the newest version of the
ActionScript language, ActionScript 3.0, which was introduced at the
same time as Flash player 9.

INSTALLATION
============

To compile this software you need to install development packages for
llvm (version 2.8 or >= 3.0), opengl, curl, zlib, libavcodec, libavresample
libglew, pcre, librtmp, cairo, libboost-filesystem, 
sdl2, sdl2_mixer, libjpeg, libavformat, pango, liblzma

If compiling the Firefox plugin is enabled (on by default), you will also need the
development package for gtk2.

If compiling the PPAPI (Chromium) plugin is enabled (on by default), keep in mind that 
it will replace the adobe flash plugin, as only one flash plugin is allowed in chromium. 

Install also cmake, nasm and gcc (version 4.6.0 or newer) or clang

To build the software please follow these steps.

1) cd lightspark
2) mkdir obj
3) cd obj
4) cmake -DCMAKE_BUILD_TYPE=Release ..
5) make
6) sudo make install

DEBUG MODE:
To enable debug mode change the cmake command like this:
4b) cmake -DCMAKE_BUILD_TYPE=Debug

CMAKE_BUILD_TYPE available: Debug LeanDebug Release RelWithDebInfo Profile

EXECUTION
=========

Using `make install`, lightspark is installed in the system wide

Browser plugin
--------------

Firefox plugin path and Firefox should show it in the about:plugins
list and in the Tools->Add-ons->Plugins window.

Lightspark registers itself as the plugin for
application/x-shockwave-flash and for application/x-lightspark, so it
should be recognisable in the about:plugins page. Its description
string is "Shockwave Flash 12.1 r<current version>". The current
version is now "r710".

Firefox is not able to deal very well with multiple plugins for the
same MIME type. If you only see a black box where a flash app should
be try to remove any other flash plugin you have installed.

Command line
------------

The command line version of Lightspark can play a local SWF file.
Execution: lightspark file.swf

Type `lightspark` to see all command line options.

Keyboard shortcuts
------------------

Ctrl+Q Quit (standalone player only)
Ctrl+M Mute/unmute sounds
Ctrl+P Show profiling data
Ctrl+C Copy an error to the clipboard (when Lightspark fails)

SWF SUPPORT
===========

Many web sites do not yet work yet because the implementation is
incomplete. See the following page for support status of selected web
sites: https://github.com/lightspark/lightspark/wiki/Site-Support

You may also try Lightspark on some known-to-work Youtube movies:

http://www.youtube.com/watch?v=ca20NEt4VSQ
http://www.youtube.com/watch?v=4N2YWRJ-ppo
http://www.youtube.com/watch?v=XITHbsUUlYI
http://www.youtube.com/watch?v=-j7c0u9yZ8M
http://www.youtube.com/watch?v=G4S9tV8ZLcE

http://www.youtube.com/watch?v=FatHLHG2uGY

REPORTING BUGS
==============

If you think you have found a bug in Lightspark, please file a bug
report at https://github.com/lightspark/lightspark/issues. See
https://github.com/lightspark/lightspark/wiki/Reporting-Bugs for help
on reporting bugs.
