Skip to content
This repository has been archived by the owner on Feb 6, 2020. It is now read-only.

Latest commit

 

History

History
81 lines (54 loc) · 3.9 KB

readme.md

File metadata and controls

81 lines (54 loc) · 3.9 KB
Raw

Project Banner

Animal Crossing Music 🍀

This is continuation of the original Animal Crossing Music project, which is no longer maintained.

Animal Crossing Music is a a fun Chrome extension for playing Animal Crossing's music in the browser, while you work, play or browse the web! ✨

The music updates in real-time on the hour, and informs you via an optional desktop notification and customizable town tune! 🌱

Features

Hourly music 🕒

Listen to the corresponding hourly music from the main Animal Crossing titles:

  • Animal Crossing
  • Wild World / City Folk
  • New Leaf

'Raining' and 'snowing' variants are also included!

Live Weather 🌧

You can enable Weather Detection so weather variants of the hourly music can be automatically picked according to the weather in your location!

K.K. Slider 🎙

Listen to K.K. Slider's songs! The extension features both 'live' and 'aircheck' version of his tunes.

You can choose whether to keep his appearances to the usual Saturday nights, or to play his songs 24/7.

Town Tune 🎵

The extension features an awesome Town Tune editor available within the browser.

With it you can compone your custom Town Tune, which will be played every time an hour passes (just as in the game!)

Installation

Notice that this project remains unpublished right now. You'll soon be able to install it through the Chrome Web Store!

Source Code

You can download the source code of the project and install the unpacked extension yourself. Just click on the Clone or download button at the top-right of the page and then on Download Zip.

To install the downloaded project, do the following:

  1. Unzip the downloaded file
  2. Go to the Chrome Extensions Page, which can be found under Chrome > Settings > Extensions
  3. Enable the Developer Mode switch
  4. Click on Load Unpacked
  5. Choose the unzipped project directory
  6. Profit!

Resources

The upcoming 4.0 version of the extension introduces a long-needed change: music is now played remotely! 🎉

The extension no longer contains music files, and the source code does not depend on resources hosted elsewhere.

Thanks to this change, the size of the extension has shrink from 436MB to only 4,1MB. That's a 99,99% decrease in size!

Downloading the music files and including them into the project directory is no longer needed in order to install/use the extension.

You can still find the used music resources in the following link:

Branch conventions

  • The master branch contains the latest published version of the extension. This is the stable branch.
  • The develop branch contains the latest fully-integrated features of the extension. This is where PRs should be merged into.

Support

If you have any questions or doubts, feel free to jump into the project's discord channel.

Contribute

Contributions to the project are greatly appreciated! Here is how you can help to make this project even better:

Issues

If you want to report a bug, or have a feature request/proposal for improvement, feel free to open a public issue on the project repository.

PR Submission

Pull Requests are equally welcomed. Just make sure to submit them to develop and give some love to the PR description!

Credit

Credit is due to all the contributors of the original project.

Licensing

Animal Crossing Music is licensed under the zlib license. See LICENSE.md for reference.