Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
angelolz committed Nov 3, 2023
1 parent 8a1df8a commit 75bb5ab
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# CHScrobbler
CHScrobbler is a simple Java app that reads the exported currently playing song text file from Clone Hero and uses that information for scrobbling to last.fm.

This app was created by a request of a friend who is a big user of last.fm. I decided to put this out in public for those that may be interested in scrobbling their songs in Clone Hero.
CHScrobbler is a small Java app designed to get the currently playing song information from exported text files of Clone Hero, ScoreSpy, and YARG, utilizing this data to scrobble to last.fm.
This app was created by a request of a friend who is a big user of last.fm. I decided to put this out in public for those that may be interested in scrobbling their songs when playing these games.

## Installation/Usage
0. Before starting the app, please make sure that **"Export Current Song"** is enabled in your Clone Hero Settings.
1. Go to your Clone Hero data folder settings and edit `settings.ini`. Near the bottom, you should find a `custom_song_export` property. Add `%n%b` to it. It should look like `custom_song_export = %s%n%a%n%c%n%b`. You may need to restart Clone Hero after changing these settings.
- For Windows, the data folder is in `%USERPROFILE%\AppData\LocalLow\srylain Inc_\Clone Hero`.
- For Mac, the data folder is in `~/Clone Hero`.
- For Linux, the data folder is in `~/.clonehero`.

2. Download the latest version of **CHScrobbler**.
3. Place the `.exe`/`.jar` file inside your own **Clone Hero directory**.
4. You may open the program. Upon opening the program, it will prompt you to provide your last.fm credentials so that it may be able to scrobble under your name.

***Note***: If you don't want to do the setup, create a file called `config.txt` in the same directory as the .exe and put these properties in it and fill it in:
```
lastfm_apikey=
lastfm_secret=
lastfm_username=
lastfm_password=
scrobble_threshold_seconds=30
```
**Note: If you are using YARG, skip to step 2.**

0. Before starting the app, please make sure that **"Export Current Song"** is enabled in your Clone Hero/ScoreSpy Settings.
1. Go to your Clone Hero/ScoreSpy data folder and edit `settings.ini`.
Near the bottom, you should find a `custom_song_export` property. Add `%n%b` to it. It should look like `custom_song_export = %s%n%a%n%c%n%b`.
You may need to restart Clone Hero after changing these settings. Refer below for the locations of the default data folders.
- Windows
- Clone Hero: `%HOMEPATH%\Documents\Clone Hero`
- ScoreSpy: `%PROGRAMFILES%\ScoreSpy Launcher\GameData\100`
- Mac
- Clone Hero: `~/Clone Hero`
- ScoreSpy: *n/a*
- Linux
- Clone Hero: `~/.clonehero`
- ScoreSpy: `~/ScoreSpy/100`

You can get your last.fm api details [here](https://www.last.fm/api/account/create).
5. After getting the app set up, you can play a song. After playing the song for 30 seconds (or whatever `scrobble_threshold_seconds` is set to), the app provides a log of the song you're currently playing and lets you know if a song was successfully scrobbled.
2. Download the latest version of **CHScrobbler**.
3. Open the program. Windows will use the `.exe` file, while Mac and Linux users will need to use the `.jar` file.
- For Mac and Linux users, use this command: `java -jar <path to .jar file>`
4. Upon opening the program, it will prompt you to provide your last.fm credentials so that it may be able to scrobble under your last.fm account.
- You can get your last.fm api details [here](https://www.last.fm/api/account/create).
- The program may ask you for locations of your data folders if it can't find the default ones.
5. After getting the app set up, you can play a song. After playing the song for 30 seconds, the app shows a log of
the song you're currently playing and lets you know if a song was successfully scrobbled.


## Dependencies Used
Expand All @@ -41,7 +43,7 @@ If you have any improvements that you think would benefit the app a lot, please
This project uses the MIT license.

# FAQ
### CHScrobbler keeps showing that I'm playing a song every second and nothing scrobbles!
### CHScrobbler keeps showing that I'm playing a song every second and nothing scrobbles! (Clone Hero/ScoreSpy)
- This is probably because CHScrobbler is unable to properly read your current playing format. Use these formats:
- Scrobbling with album name:
`custom_song_export = %s%n%a%n%c%n%b`
Expand All @@ -53,4 +55,8 @@ This project uses the MIT license.
Windows in [this site](https://www.geeksforgeeks.org/how-to-set-java-path-in-windows-and-linux/) to set Java in your `PATH` system variable.

### CHScrobbler has the song/artist/album swapped around!
- You may have changed your `custom_song_export` in your `settings.ini` file and forgot to restart Clone Hero and/or CHScrobbler.
- You may have changed your `custom_song_export` in your `settings.ini` file and forgot to restart your game and/or CHScrobbler.

### Why did CHScrobbler tell me it couldn't scrobble the current playing song?
- This may be because of inaccurate metadata being given to last.fm.
In Clone Hero/ScoreSpy if there's no album/artist in the song info, it would show "Unknown Artist" or "Unknown Album" and last.fm ignores these.

0 comments on commit 75bb5ab

Please sign in to comment.