Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 3.04 KB

README.md

File metadata and controls

52 lines (40 loc) · 3.04 KB
Raw

Web-Chiptune-Player

A library to allow frontend web programmers to embed chiptune into their websites.

You can:

  • play back a song with infinite looping
  • play back a song with 2 loops and a fade
  • generate an <audio> element for playback controls
  • render a chiptune then download it as a wav file.
  • Take a mono system, and pan its voices left or right (currently only for the game_music_emu file types)

It is currently a work in progress. It can play:

  • VGM & VGZ (many consoles) via libvgm
  • SPC (Super Famicom/SNES) via snes_spc
  • PSF (PlayStation 1 Sequenced Music) via upse123
  • These file types via the game_music_emu library:
    • NSF & NSFE (Famicom/NES)
    • GBS (Game Boy)
    • AY (ZX Spectrum, Amstrad CPC)
    • SAP (Atari)
    • HES (PC Engine/TurboGrafx-16)

Instead of rendering the song while the user is listening to it, which can result in poor audio quality on mobile and other low-end hardware; Web-Chiptune-Player renders one whole loop of the song and then plays the music (looping is done after the song has rendered). The trade-off is that you'll have to wait a few seconds before the song starts, but the quality should always be good.
Many chiptune files (except vgm & vgz) do not have the correct length in their metadata; thus, to use Web-Chiptune-Player to its full potential, please always input the correct renderLength (the length of one loop, including intro) and introLength (the length of just the intro).
(Note: the above does not apply to non-looping songs)

This repository will be a combination of all my other web chiptune repositories.

To learn more, please view the demo.

To see an example of how this library would be used on a real website, please view this chiptune blog post.

Folders

web

This folder contains only the files you need to put on your website to use the library, if you wish to self-host. Currently, the library is hard-coded to be used from the CDN jsDelivr.

docs

This folder contains the demo; the test-music folder contains various chiptune files that I use to test the library.

sources

This folder contains the c source code of the Emscripten modules used in the library.

Credits

This library borrows code from many different open source libraries. If a library I used is not mentioned here, its source should be listed in a text file in the repository.