Skip to content

Commit

Permalink
docs: Add usage instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
p-fruck committed Feb 2, 2024
1 parent 630bbd0 commit a7e09ea
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,20 @@ Installation of the extension depends on your browser and is easiest in Chromium
4. Select the `browser` folder
5. Navigate to [app.jimmi.party](https://app.jimmi.party/) and let the party begin!

## Usage

Jimmi is a chat bot. You can ask him to `!play some music` which will search `some music` on YouTube (or rather [invidious](https://invidious.io/) which provides API access without an account). For a full list of features, use the `!help` command.

The ensure access to audio devices, please use the form to connect to a Jitsi instance. If you just reload the page `https://app.jimmi.party/#/bot/my.jitsi.instance/my-conference` (or connect to it directly) you might run into issue with [autoplay](https://goo.gl/xX8pDD).

**Caveats**

Jimmi uses a randomized list of Invidious instances to play back music. Those instances are run by volunteers and might suffer from bugs or downtime. If you notice that a specific instance is not functioning, please report this as an issue.

Another unresolved issue is that googlevideo (where the music tracks are fetched from) might return 403 forbidden for some videos (idk why). In that case you wont be able to play that specific video and have to choose another song - Sorry for the inconvenience.

Jitsi is complicated. YouTube too. If you experience any further problems, feel free to report problems using GitHub issues or discussions and submit pull requests if you have the required knowledge ;)

# :blue_book: License

Jimmi is licensed under `GNU Affero General Public License v3.0`!

0 comments on commit a7e09ea

Please sign in to comment.