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

Commit

Permalink
docs(readme): clean up README and credit authors (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
@xeruf
xeruf committed May 29, 2020
1 parent e54dd49 commit af57604
Showing 1 changed file with 34 additions and 25 deletions.
59 changes: 34 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,46 @@
# ![icon](assets/favicon.png) MonsterUtilities ![Discord](https://img.shields.io/discord/417314230681993226.svg?logo=discord) [![Build Status](https://semaphoreci.com/api/v1/xerus2000/monsterutilities/branches/master/shields_badge.svg)](https://semaphoreci.com/xerus2000/monsterutilities)

Browse, stream and download Monstercat Songs, powered by the Monstercat API and MCatalog. [This is the story of how it came to be.](assets/Story.md)
Browse, stream and download [Monstercat] Songs, powered by the [Monstercat API] and [MCatalog].

> Current state: The application has been used by many people without major problems. But it will probably stay in "beta" because the [main developers](#credits) are not as active anymore.
We are however still available for questions in the [Discord] or via [GitHub issues][issues] and would welcome new contributors!

- [Getting started](#getting-started)
- [Troubleshooting](#troubleshooting)
- [Caching & Offline usage](#caching--offline-usage)
- [Screenshots](#screenshots)

_The application is still in a beta state, you may encounter bugs. Please report issues via GitHub and send a report from inside the application. The latter will automatically include logs from `TEMP/monsterutilities/logs`._
- [Credits](#credits)

## Getting started

Download the portable version from [the website](https://monsterutilities.bplaced.net/downloads?download) or from [GitHub releases](https://github.com/Xerus2000/monsterutilities/releases).
Download OS-specific installers from [GitHub releases](https://github.com/Xerus2000/monsterutilities/releases) with an optional bundled Java environment.

If you did not choose a download with a bundled JRE, the application requires [Java 8 by Oracle](https://www.java.com/de/download/manual.jsp) to be installed on your computer.
Packaged portable versions as well as OS-specific installers, optionally with a bundled JRE, are available from [GitHub releases](https://github.com/Xerus2000/monsterutilities/releases).
For packages without a bundled JRE, the application requires [Java 8 by Oracle](https://www.java.com/download).

Make sure to read the initial in-app guide and watch out for tooltips.

## Troubleshooting
### Authentication

#### Authentication - the connect.sid
For downloading and listening to early access, insert a valid `connect.sid` at the bottom of the Downloader.
Obtain it though the process below or simply supply your credentials to the login form in the application.

For downloading and listening to early access, your `connect.sid` needs to be entered in the bottom of the Downloader. It is a cookie that identifies your Monstercat Account.
You can either login with your credentials or obtain it manually as described below.
1) [Sign in on monstercat.com][Monstercat-signin] and ensure that you have a valid [Monstercat Gold] subscription
2) Find a cookie for `connect.monstercat.com` in your browser
Chromium-based browsers: [chrome:https://settings/cookies/detail?site=connect.monstercat.com](chrome:https://settings/cookies/detail?site=connect.monstercat.com)
Firefox: Go to https://connect.monstercat.com/ (ignore any errors), open dev tools (Ctrl+Shift+I), go to `Storage > Cookies > https://connect.monstercat.com`
3) Find the content of `connect.sid` - a string starting with `s%3A` and around 90 characters in length
4) Copy that string into the `connect.sid` Textfield at the bottom of the Downloader

1) Log in on [monstercat.com/gold](https://www.monstercat.com/gold) and ensure that you have a valid Monstercat Gold subscription
2) Go to your browser cookies and search for `connect.monstercat.com`
For Chromium-based browsers: `chrome:https://settings/cookies/detail?site=connect.monstercat.com`
3) Find the content of `connect.sid`. It is a string starting with `s%3A` and has around 90 characters.
4) Copy that string into the `connect.sid` Textfield at the bottom of the Downloader.
The `connect.sid` can be used to obtain full access to your account, so treat it carefully. The application never sends it anywhere but [Monstercat] servers.
Please note though that it is persisted on your computer using the [Java Preferences API](https://stackoverflow.com/a/1320798) for your convenience.

#### Downloader
### Caching & Offline usage

Sometimes the cache runs into issues which may cause problems in the Downloader. In that case use the "Clear cache & Restart" button in the settings to reset the cache.

> If you still have issues, hit me up on [Discord](https://discord.gg/ZEusvHS) or send Feedback directly from the application!
## Caching & Offline usage

Upon starting the application for the first time, it will fetch and cache all Releases as well as Sheets (Catalog/Genres). This might take some time depending on your internet connection. On subsequent use it will prefer to fetch incrementally, reducing the load on your connection as well as Monstercat's Servers.
Upon starting the application for the first time, it will fetch and cache all Releases as well as Sheets (Catalog/Genres). This might take some time depending on your internet connection. On subsequent use it will prefer to fetch incrementally, reducing the load on your connection as well as [Monstercat]'s Servers.
Once fetched, Songs can be **browsed offline** but **not played or downloaded**.

The cache as well as logs are stored in the TEMP directory, depending on your operating system:
Cache and logs are stored in a temporary directory, depending on your operating system:
- Windows: `C:\Users\<username>\AppData\Local\Temp\monsterutilities` - can be changed by editing the `java.io.tmpdir` system property
- Unix: `/var/tmp/monsterutilities`, or under `/tmp` if `/var/tmp` does not exist

Expand Down Expand Up @@ -77,6 +75,17 @@ The application has various color schemes and configuration options.

![Settings](assets/screenshots/settings.png)

## Acknowledgments
## Credits

[@xerus2000](https://github.com/xerus2000) [founded the project](assets/Story.md) and established most of its features. He still technically owns it, but has [mostly moved on to other projects](https://github.com/search?q=author%3Axerus2000&type=Issues).
[@defvs](https://github.com/defvs) is currently the main maintainer, but rarely gets around to anything other than critical fixes.

We thank [![install4j](https://www.ej-technologies.com/images/product_banners/install4j_small.png)](https://www.ej-technologies.com/products/install4j/overview.html) for providing a free license to build the installers.

Thanks to [![install4j](https://www.ej-technologies.com/images/product_banners/install4j_small.png)](https://www.ej-technologies.com/products/install4j/overview.html) for providing us a free license to build the installers.
[issues]: https://github.com/xerus2000/monsterutilities/issues
[Discord]: https://discord.gg/ZEusvHS
[Monstercat]: https://monstercat.com
[Monstercat API]: https://github.com/defvs/connect-v2-docs/wiki
[Monstercat Gold]: https://www.monstercat.com/gold
[Monstercat-login]: https://www.monstercat.com/signin
[MCatalog]: https://docs.google.com/spreadsheets/d/116LycNEkWChmHmDK2HM2WV85fO3p3YTYDATpAthL8_g

0 comments on commit af57604

Please sign in to comment.