Skip to content

Commit

Permalink
small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Gröger committed Apr 30, 2020
1 parent 2026853 commit 3d78ca5
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 118 deletions.
85 changes: 1 addition & 84 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,51 +29,16 @@ MacOS: [ts3audiobot-client-09-mac.zip](https://github.com/kevingroeger/TS3AudioB

## Overview

- [Features](#features)
- [Serverside setup](#serverside-setup)
- [Configuration](#configuration)
- [Base Url](#base-url)
- [Bot Config](#bot-config)
- [Api Key](#api-key)
- [Usage](#usage)
- [Dashboard](#dashboard)
- [Playlist](#playlist)
- [Radio](#radio)
- [Toplist](#toplist)
- [History](#history)
- [Known issues and bugs](#known-issues-and-bugs)
- [Known issues](#known-issues)
- [Customizing the app](#customizing-the-app)
- [License](#license)

## Features

[Back to Overview](#overview)

(Different styles have been used on these pictures)

### Clear Overview

<p align="center">
<a href="https://imgur.com/7JVO7yJ.png" ><img width="42%" src="https://imgur.com/7JVO7yJ.png" /></a>
<a href="https://imgur.com/UAj6mLX.png" ><img width="42%" src="https://imgur.com/UAj6mLX.png" /></a>
</p>

### See your history

<p align="center">
<a href="https://imgur.com/e5xdR7l.png"><img width="54%" src="https://imgur.com/e5xdR7l.png" /></a>
</p>

### Configurable with different styles

<p align="center">
<a href="https://imgur.com/htj2zw0.png"><img width="42%" src="https://imgur.com/htj2zw0.png" /></a>
<a href="https://imgur.com/ib3Xep2.png"><img width="42%" src="https://imgur.com/ib3Xep2.png" /></a>
</p>

[More pictures can be found on Usage](#usage)

## Serverside setup

[Back to Overview](#overview)
Expand Down Expand Up @@ -136,61 +101,13 @@ If you want to use api keys, just open a private chat to any bot on your TeamSpe

Make sure to save your configuration.

## Usage

[Back to Overview](#overview)

(Different styles have been used on these pictures)

Altough the usage is pretty straight forward, here is a quick overview:

### Dashboard

If a song is currently playing, it will be shown here with some basic controls (play/pause, next)

Also you can enter a mp3 radiostream, a youtube link or another supported link here. For more information about what is supported visit [Splamy's TS3AudioBot](https://github.com/Splamy/TS3AudioBot).

<p align="center">
<a href="https://imgur.com/UAj6mLX.png"><img width="54%" src="https://imgur.com/UAj6mLX.png" /></a>
</p>

### Playlist

You can create, play and add playlists to the queue here. Only youtube playlists are supported. Names cannot include any whitespaces. The playlists will be saved for everyone using the app.

<p align="center">
<a href="https://imgur.com/CZ7dF9y.png"><img width="42%" src="https://imgur.com/CZ7dF9y.png" /></a>
<a href="https://imgur.com/pccEwoz.png"><img width="42%" src="https://imgur.com/pccEwoz.png" /></a>
</p>

### Radio
<p align="center">
<a href="https://imgur.com/0Aay2b6.png"><img width="54%" src="https://imgur.com/0Aay2b6.png" /></a>
</p>

There is currently only a small choice of preconfigured radio streams here. If you want to add your own radio go to [Customizing the app](#customizing-the-app).

### Toplist

The most played songs will be shown here in a compact list.

### History

<p align="center">
<a href="https://imgur.com/e5xdR7l.png"><img width="54%" src="https://imgur.com/e5xdR7l.png" /></a>
</p>

The last 12 songs are shown here.

## Known issues and bugs

This is an early build, so there are some things that I couldn't yet implement.

If you find a bug that is not listed here, please submit it as an Issue.

#### Known issues:

There are currently no known issues. If you find a bug please create an issue. Thanks!
- Performance Issues

## Customizing the app

Expand Down
34 changes: 27 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
{
"name": "ts3audiobot-client",
"version": "1.0.1",
"version": "1.0.0",
"private": true,
"main": "src/electron.js",
"homepage": "./",
"main": "public/electron.js",
"build": {
"appId": "com.electron.kevingroeger",
"productName": "TS3AudioBot-Client",
"copyright": "Copyright © 2020 kevingroeger",
"mac": {
"category": "public.app-category.utilities"
},
"directories": {
"buildResources": "assets"
}
},
"files": [
"build/**/*",
"node_modules/**/*"
],
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^1.2.28",
"@fortawesome/free-brands-svg-icons": "^5.13.0",
Expand All @@ -11,7 +27,7 @@
"@fortawesome/react-fontawesome": "^0.1.9",
"@reduxjs/toolkit": "^1.3.5",
"bootstrap": "^4.4.1",
"electron-builder": "^22.4.1",
"electron-is-dev": "^1.2.0",
"electron-json-config": "^1.5.3",
"react": "^16.13.1",
"react-bootstrap": "^1.0.0",
Expand All @@ -20,15 +36,17 @@
"react-router-dom": "^5.1.2",
"react-scripts": "3.4.1",
"react-spinners": "^0.8.1",
"react-timeout": "^1.2.0",
"yt-search": "^1.1.2"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"electron": "electron ."
"electron": "electron .",
"postinstall": "electron-builder install-app-deps",
"preelectron-pack": "yarn build",
"electron-pack": "electron-builder build -mw"
},
"eslintConfig": {
"extends": "react-app"
Expand All @@ -46,8 +64,10 @@
]
},
"devDependencies": {
"cheerio": "^0.22.0",
"@rescripts/cli": "0.0.14",
"electron": "^8.2.1",
"react-redux": "^7.2.0"
"react-redux": "^7.2.0",
"electron-builder": "^22.4.1",
"typescript": "^3.8.3"
}
}
34 changes: 7 additions & 27 deletions package_build.json → package_dev.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,8 @@
{
"name": "ts3audiobot-client",
"version": "1.0.1",
"version": "1.0.0",
"private": true,
"homepage": "./",
"main": "public/electron.js",
"build": {
"appId": "com.electron.kevingroeger",
"productName": "TS3AudioBot-Client",
"copyright": "Copyright © 2020 kevingroeger",
"mac": {
"category": "public.app-category.utilities"
},
"directories": {
"buildResources": "assets"
}
},
"files": [
"build/**/*",
"node_modules/**/*"
],
"main": "src/electron.js",
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^1.2.28",
"@fortawesome/free-brands-svg-icons": "^5.13.0",
Expand All @@ -27,7 +11,7 @@
"@fortawesome/react-fontawesome": "^0.1.9",
"@reduxjs/toolkit": "^1.3.5",
"bootstrap": "^4.4.1",
"electron-is-dev": "^1.2.0",
"electron-builder": "^22.4.1",
"electron-json-config": "^1.5.3",
"react": "^16.13.1",
"react-bootstrap": "^1.0.0",
Expand All @@ -36,17 +20,15 @@
"react-router-dom": "^5.1.2",
"react-scripts": "3.4.1",
"react-spinners": "^0.8.1",
"react-timeout": "^1.2.0",
"yt-search": "^1.1.2"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"electron": "electron .",
"postinstall": "electron-builder install-app-deps",
"preelectron-pack": "yarn build",
"electron-pack": "electron-builder build -mw"
"electron": "electron ."
},
"eslintConfig": {
"extends": "react-app"
Expand All @@ -64,10 +46,8 @@
]
},
"devDependencies": {
"@rescripts/cli": "0.0.14",
"cheerio": "^0.22.0",
"electron": "^8.2.1",
"react-redux": "^7.2.0",
"electron-builder": "^22.4.1",
"typescript": "^3.8.3"
"react-redux": "^7.2.0"
}
}

0 comments on commit 3d78ca5

Please sign in to comment.