Download:
child 34:37269c0508ae
parent 32:4f7b756c603c
33:e4d8b468e188
Anton Shestakov <av6@dwimlabs.net>, Thu, 21 Jun 2018 19:46:35 +0800
docs: first rough readme

1 файлов изменено, 50 вставок(+), 0 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Thu Jun 21 19:46:35 2018 +0800
@@ -0,0 +1,50 @@
+gme-player.js
+=============
+
+What is it? It's a music player in the browser. Or, it's yet another interface
+to `Game Music Emu`_ (to be precise, `mpyne's fork`_) compiled with Emscripten.
+
+It should support all formats that libgme supports, with the exception of
+compressed formats. Compressed formats, such as VGZ, depend on ZLib and are
+not supported for now.
+
+
+Usage
+-----
+
+The simplest way to see it in action is:
+
+.. code-block:: sh
+
+ cd gme-player.js
+ make
+ # add music files: .nsf, .nsfe, .spc, .vgm, etc
+ python -m SimpleHTTPServer
+
+And then navigate to http://localhost:8000/.
+
+
+Where to get files?
+-------------------
+
+Check out `Famicompo mini`_.
+
+
+Hacking
+-------
+
+recipe.sh has some tips on how to build Game Music Emu with Emscripten.
+
+
+TODO
+----
+
+Upgrade bundled libgme. 0.6.2 broke many NSFe files, fixed in master, let's
+wait for 0.6.3 then.
+
+Support compressed formats (``-DLIBTYPE=STATIC``?).
+
+
+.. _Game Music Emu: http://blargg.8bitalley.com/libs/audio.html
+.. _mpyne's fork: https://bitbucket.org/mpyne/game-music-emu
+.. _Famicompo mini: http://midr2.under.jp/