digimezzo / dopamine

The audio player that keeps it simple

Dopamine

Dopamine is an elegant audio player which tries to make organizing and listening to music as simple and pretty as possible. This version is written using Electron, Angular and Typescript. The original Dopamine (for Windows), which is written in WPF and C#, remains available here.

Dopamine icons created by Sharlee.

Thank you JetBrains!

Thank you JetBrains for supporting this project!

Debugging

I recommend using JetBrains Rider or WebStorm to debug this project. The .run folder contains a debugging configuration Debug renderer that allows you to attach to the Dopamine instance that is started when running npm start. Most of the code runs in the Electron renderer. That is why only a renderer configuration is provided for now.

Build prerequisites

• rpm: required to build rpm package
• libarchive-tools: contains bsdtar, which is required to build pacman package.

Build prerequisites on Ubuntu:

• Install Node.js 16
• Install your IDE of choice (Rider, WebStorm, Visual Studio Code, ...)
• Install rpm (required to build rpm package) and libarchive-tools (contains bsdtar, which is required to build pacman package): sudo apt install rpm libarchive-tools

Follow the build instructions below to start or build Dopamine for your platform.

Build prerequisites on Manjaro:

• Install Node.js 16:
  • yay -S nvm
  • nvm install 16
• Install your IDE of choice (Rider, WebStorm, Visual Studio Code, ...)
• Install rpm (required to build rpm package): sudo pacman -S rpm-tools

Follow the build instructions below to start or build Dopamine for your platform.

Build prerequisites on Windows:

• Download and install Node.js 16 from https://nodejs.org (During the installation, select all features and check the box to install Tools for Native Modules).
• After the installation of Node.js, restart computer to ensure that npm is added to the path.
• Install your IDE of choice (Rider, WebStorm, Visual Studio Code, ...)
• Download the Dopamine source code
• Open the "dopamine" folder (the folder containing package.json) in your IDE

Follow the build instructions below to start or build Dopamine for your platform.

Build prerequisites on MacOS:

• Install Node.js 16 from https://nodejs.org (During the installation, select all features and check the box to install Tools for Native Modules).
• Make sure npm is accessible via the console
  • Press command + space and search for console
  • Write npm --v and press enter, this should give you the version number if npm is properly installed.
• Install your IDE of choice (Rider, WebStorm, Visual Studio Code, ...)
• Download the Dopamine source code
• Open the "dopamine" folder (the folder containing package.json) in your IDE

Build instructions

Due to the native dependency better-sqlite3, this project cannot be built for all platforms on GNU/Linux. The GNU/Linux packages must be built on GNU/Linux, the Windows package must be built on Windows and the MacOS package must be built on MacOS.

$ git clone https://github.com/digimezzo/dopamine.git
$ cd dopamine
$ npm install                # Install dependencies
$ npm start                  # Start Dopamine
$ npm run electron:windows   # Build for Windows
$ npm run electron:linux     # Build for Linux
$ npm run electron:mac       # Build for Mac

Pacman installation notes

The pacman package can be installed using this command (replace x.y.z with the correct version number):

$ sudo pacman -U Dopamine-x.y.z.pacman

If you're getting an error concerning a missing package libappindicator-sharp, use this command to perform the installation instead (replace x.y.z with the correct version number):

$ sudo pacman -U Dopamine-x.y.z.pacman --assume-installed libappindicator-sharp