README

   1
   2 This is Moonlight, an open source implementation of Silverlight 1.0
   3 and 2.0 for Unix systems.
   4
   5 See http://www.mono-project.com/Moonlight for more information.
   6
   7 Installation
   8 ============
   9
  10         For standard Unix configuration/installation instructions, see the INSTALL file.
  11
  12 Requirements
  13 ============
  14
  15         At this time, Moonlight trunk (this release) requires you to use the
  16         Mono 2.6 branch.   To build Moonlight, you need to get both
  17         the mono and mcs modules from the mono-2-6 branch at revisons:
  18         r147226.
  19
  20         Do this like this:
  21
  22                 svn co -r 147226 http://anonsvn.mono-project.com/source/branches/mono-2-6/mono
  23                 svn co -r 147226 http://anonsvn.mono-project.com/source/branches/mono-2-6/mcs
  24
  25
  26 Runtime Options
  27 ===============
  28
  29         There is a couple of runtime-parameters that affect Moonlight behavior
  30         and turn on/off certain features. Those options are specified through
  31         the MOONLIGHT_OVERRIDES env variable. The more interesting ones are:
  32
  33         * shapecache=yes/no
  34
  35                 Use some extra memory for caching shapes.  Increases
  36                 memory usage but helps with performance (off by
  37                 default). The shape cache size is 6MB max.
  38
  39         * render=ftb/btf
  40
  41                 Use front-to-back or back-to-front rendering (ftb is
  42                 the default).
  43
  44         * cache=show/hide
  45
  46                 Show the (shape) cache usage statistics. In plugin
  47                 mode they're available through the right-click popup
  48                 menu (hide by default).
  49
  50         * converter=yuv/ffmpeg
  51
  52                 Use native mmx/sse2 conversion code or ffmpeg to do
  53                 the yuv -> rgb colorspace conversion (by default we
  54                 use the native yuv code).
  55
  56         To launch Firefox with shape caching and ffmpeg converters use:
  57
  58                 $> MOONLIGHT_OVERRIDES="shapecache=yes,converter=ffmpeg" firefox
  59
  60
  61         Other options include:
  62
  63         * ms-codecs=yes/no
  64         * ffmpeg-codecs=yes/no
  65
  66                 Controls which sets of codecs to use, the Microsoft
  67                 ones or the ffmpeg ones.
  68
  69         * timesource=manual/system
  70
  71                 Defaults to `system'.
  72
  73
  74         Also if --with-debug=yes option was provided to configure script, the
  75         MOONLIGHT_DEBUG env variable controls which debug output is printed
  76         on the console. Valid values are:
  77
  78                 alsa, alsa-ex, audio, audio-ex, pulse, pulse-ex, httpstreaming,
  79                 markers, markers-ex, mms, mediaplayer, mediaplayer-ex, pipeline,
  80                 pipeline-error, framereaderloop, ui, ffmpeg, codecs, dependencyobject,
  81                 downloader, font, layout, media, mediaelement, mediaelement-ex,
  82                 buffering, asf, playlist, playlist-warn, text, xaml
  83
  84
  85 Licensing
  86 =========
  87
  88         The C and C++ code that makes up the engine is dual-licensed
  89         under the LGPL v2 license and is also available commercially
  90         for developers interested in using Moonlight on embedded
  91         systems or other systems where the end-user can not upgrade
  92         the LGPL code on his own.
  93
  94         The C# tests in test/2.0/Microsoft.Silverlight.Testing are
  95         copyrighted by Microsoft and released by them under the
  96         open source MS-PL license.
  97
  98         The C# controls in class/Microsoft.SilverlightControls/ and
  99         class/WPF.Toolkit are copyrighted by Microsoft and released by
 100         them under the open source MS-PL license.
 101
 102 Technical Details
 103 =================
 104
 105         For implementation details and notes, see the NOTES file.
 106
 107
 108 Test Suite
 109 ==========
 110
 111         To run the test suite, make sure that the output from
 112         configure indicates that the tests will be run.  Once this is
 113         done, you can run the tests like this:
 114
 115         To run the Novell tests:
 116
 117                 cd moon/tests
 118                 ./make-xephyr run-tests
 119
 120         To run the Microsoft tests (you need the moonlight-ms module
 121         as a peer of moon):
 122
 123                 cd moon/test
 124                 ./make-xephyr run-ms-tests
 125
 126         To run the Moonlight Unit Tests:
 127
 128                 cd moon/test/2.0/moon-unit
 129                 make test
 130
 131
 132 Firefox 3
 133 =========
 134
 135         The original Silverlight.js shipped by Microsoft was incompatible
 136         with Firefox 3.  We have released a greasemonkey script
 137         (data/silverlight-ff3-quirks.user.js) that will patch this behaviour
 138         for some sites.
 139
 140