zzfx

A Tiny JavaScript Sound FX System

  • zzfx

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
zzfx
50861.2.18 months ago3 years agoMinified + gzip package size for zzfx in KB

Readme

ZzFX - Zuper Zmall Zound Zynth

ZzFX Features

  • Tiny sound generator with 20 controllable parameters
  • Play audio via code, no need for sound asset files
  • Compatible with nearly all web browsers
  • Small code footprint, the micro version is under 1 kilobyte uncompressed
  • Can produce a large variety of sound effect types
  • Sounds can be played with a short function call
  • No additional libraries or dependencies are required
  • Open source with MIT license, you can use this for anything!
Why Use ZzFX?
  • You can quickly add or change sound effects with just one line of code
  • Without sound asset files your game is smaller and faster for users to download
  • While prototyping you can use ZzFX for placeholder sound effects
  • For size limited game jams like JS13K, ZzFX uses very minimal overhead
  • ZzFX is not just for games, you can use it to easily add sounds to any website
How to Use
  • Download from github or use npm install zzfx
  • Import ZZFX as a module with using import {ZZFX, zzfx} from './ZzFX.js'
  • To play a sound just call zzfx(), something like zzfx(...[,,,,.1,,,,9])
Here are a few more examples examples... ```javascript zzfx(...,,925,.04,.3,.6,1,.3,,6.27,-184,.09,.17); // Game Over zzfx(...,,537,.02,.02,.22,1,1.59,-6.98,4.97); // Heart zzfx(...1.5,.8,270,,.1,,1,1.5,,,,,,,,.1,.01); // Piano zzfx(...,,129,.01,,.15,,,,,,,,5); // Drum ``` ZzFX Image

ZzFX Music

  • Both the player and songs are super tiny and compress well
ZzFX Micro Code
Here's all the code you need to play ZzFX sounds with JavaScript! ```javascript // ZzFXMicro - Zuper Zmall Zound Zynth - v1.2.1 by Frank Force ~ 880 bytes zzfxV=.3 // volume zzfx= // play sound (p=1,k=.05,b=220,e=0,r=0,t=.1,q=0,D=1,u=0,y=0,v=0,z=0,l=0,E=0,A=0,F=0,c=0,w=1,m= 0,B=0,M=Math,R=44100,d=2M.PI,G=u=500d/R/R,C=b=(1-k+2kM.random(k=))d/R,g =0,H=0,a=0,n=1,I=0,J=0,f=0,x,h)=>{e=Re+9;m=R;r=R;t=R;c=R;y=500d/R3;A=d /R;v=d/R;z=R;l=Rl|0;for(h=e+m+r+t+c|0;aa++=f)++J%(100F|0)||(f=q?13):M.max(M.min(M.tan(g),1),-1):1-(2g/d%2+2)%2:1-4M.abs(M. round(g/d)-g/d):M.sin(g),f=(l?1-B+BM.sin(da/l):1)(0M.abs(f)DzzfxV p(a(1-w):aw:0),f=c?f/2+(c>a?0: (aka-c|0/2):f),x=(b+=u+=y)M.cos(AH++),g+=x-xE(1-1E9(M.sin (a)+1)%2),n&&++n>z&&(b+=v,C+=v,n=0),!l||++I%l||(b=C,u=G,n=n||1);p=zzfxX. createBuffer(1,h,R);p.getChannelData(0).set(k);b=zzfxX.createBufferSource();b. buffer=p;b.connect(zzfxX.destination);b.start();return b};zzfxX=new AudioContext; ```

ZzFX UI Features

  • Generates random sounds from presets
  • Sound list is automatically saved
  • Each parameter can be modified with constraints
  • Lock and mutate buttons for each parameter
  • Sounds can be renamed
  • Shortens code for zzfx sound calls
  • Displays image of sound wave when played
  • Sounds can be marked as favorites to prevent removal
  • Sounds can be loaded by pasting zzfx code for easy sharing
  • List of sounds can be exported and imported
  • Supports drag-and-drop of exported files into sound list
  • Supports saving sounds as wav files for offline playback

Games Using ZzFX

ZzFX Image