Installation: Windows

Installation

• Download & Install Node.js 14
• Download & Install git
• Open Windows Comand Prompt
• Type CD C:\ to change directory to the root C: drive
• Type git clone https://github.com/jef/streetmerchant.git
• Type CD streetmerchant
• Type npm install
• Navigate to the newly created C:\streetmerchant\ in Windows Explorer
• Rename the file .env-example to .env
• Edit .env file to your liking using notepad or similar and save
  • More on this in README.md#customization
• In Windows Command Prompt type npm run start from the C:\streetmerchant\ directory

At any point you want the program to stop, use Ctrl + C.

Bot Update

• End the bot by pressing Ctrl + C.
• Type git pull origin main
• Type npm install (only required if there are new dependencies)
• Type npm run start

Audio Notifications

This is required to make audio notifications work in Windows

• Download cmdmp3 binaries
• Extract all .exe files directly into your C:\streetmerchant\
• Place your notification sound in your C:\streetmerchant\
• Update your .env to include PLAY_SOUND=soundname.wav (supported file types: wav, mp3, flac)
• Save your .env
• Restart the bot with Ctrl + C then npm start run

Extras

It may be helpful to show file extensions. Winzip has a good article on this.

---

For further customization, visit the README.md#customization for the most up-to-date settings.