Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.35 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.35 KB

Audio Dot Visualizer

Preview

A wallpaper plugin for Lively Wallpaper for Windows. Displays the computer's audio as a spectrum of dots.

Installation

  1. Download the latest version of the Audio Dot from the releases page.
  2. Drag the .zip file into Lively.
  3. Set the Audio Dot wallpaper with a click.
  4. Play music and enjoy!

You can customize the appearance via the right-click on the Lively UI.

For Developers

Prerequisites

Required

Recommended

Setup (via terminal)

Clone the repository

git clone https://github.com/DigitalNaut/AudioDotVisualizer.git && cd AudioDotVisualizer && git checkout main && git pull origin main

Install dependencies

npm install # OR pnpm install OR yarn install

Open the project in Visual Studio Code

code .

Build

I've provided a script that will build the project from TypeScript into JavaScript and package it into a .zip file in the /dist folder using 7zip. Note that it'll also minifiy the JavaScript code.

npm run build # OR pnpm build OR yarn build

I've also added two more scripts:

One to check the TypeScript code for type errors.

npm run typecheck # OR pnpm typecheck OR yarn typecheck

And another to delete the generated files in the /dist and /build folders.

npm run purge # OR pnpm purge OR yarn purge

Run

Unfortunately, I haven't figured out how to automate the importing of the project into Lively or run then project directly from the source code, so you'll have to build the project first and then import it manually:

  1. Open Lively Wallpaper.
  2. Open the /dist folder (it'll open automatically with the npm run build command).
  3. Drag the AudioDot_vX.X.X.zip file into Lively Wallpaper.
  4. Set the Audio Dot wallpaper with the latest changes.