Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/exopandora/betterchat

Unofficial addon for TeamSpeak 5 which adds support for BBCodes and rich embeds
https://github.com/exopandora/betterchat

Last synced: 8 days ago
JSON representation

Unofficial addon for TeamSpeak 5 which adds support for BBCodes and rich embeds

Host: GitHub
URL: https://github.com/exopandora/betterchat
Owner: Exopandora
License: mit
Created: 2022-08-11T18:32:20.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-05-10T14:12:17.000Z (6 months ago)
Last Synced: 2024-10-31T11:36:32.907Z (15 days ago)
Language: JavaScript
Homepage:
Size: 425 KB
Stars: 6
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # BetterChat #

BetterChat is an unofficial addon for TeamSpeak 5 and aims to provide a better chat experience for the TeamSpeak 5 client. It enables support for BBCodes, improving messages sent by TeamSpeak 3 users, and automatic rich embeds for any website, including dedicated embeds for video, audio, image and twitter content. It works in both compact and detailed view.

## BBCode support ##  

BetterChat readds support for BBCodes in chat, just like in TeamSpeak 3. Currently the following tags are supported:

| Name | Syntax  | Example |

| ---- | ------- | ------- |

| bold  | [b]bold[/b] | ![bold](images/bbcodes/bold.png) |

| code | [code]code[/code] | ![code](images/bbcodes/code.png) |

| color | [color=#00F]hexcode[/color] or [color=blue]css color[/color] | ![color](images/bbcodes/color.png) |

| italic | [i]italic[/i] | ![italic](images/bbcodes/italic.png) |

| spoiler | [spoiler]spoiler[/spoiler] | ![spoiler](images/bbcodes/spoiler.png) |

| strike | [s]strike[/s] | ![strike](images/bbcodes/strike.png) |

| underline | [u]underline[/u] | ![underline](images/bbcodes/underline.png) |

| url | [url]https://example.com[/url] or [url=https://example.com]text[/url] | ![url](images/bbcodes/url.png) |

| pre | [pre]inline code[/pre] | ![pre](images/bbcodes/pre.png) |

## Rich Embeds ##

BetterChat supports automatic rich embeds for any website, including dedicated embeds for video, audio, image and twitter content. Due to technical limitations, not all video and audio formats are supported at the moment.

### Video Embed ###

![Video Embed](images/embeds/video.png)

### Audio Embed ###

![Audio Embed](images/embeds/audio.png)

### Twitter Embed ###

![Twitter Embed](images/embeds/twitter.png)

### Generic Embed ###

![Generic Embed](images/embeds/generic.png)

## Styling ##

Custom styling for the image preview can be changed in the `style.css`.

Rich embeds use the already existing css classes of the TeamSpeak client and should be compatible with already existing themes.

## Installation ##

Notes:

> * Manual installation only works for TeamSpeak 5 beta 70

> * Depending on your installation directory you may need elevated permission privileges

> * The installation process needs to be repeated after each TeamSpeak update

> * Please check the [compatibility](https://github.com/Exopandora/BetterChat#compatibility) section before installing BetterChat

### Installer ###

Installation steps:

1. Download the installer for your operating system from [here](https://github.com/FelixVolo/TS5AddonInstaller/releases)

2. Start the installer

3. Select your TeamSpeak installation directory

4. Select "BetterChat"

5. Click on "Install"

### Manual ###

Installation steps:

1. Navigate to your TeamSpeak installation directory

2. Navigate to `./html/client_ui/`

3. Open `index.html` in that directory with an editor and copy all contents from the `index.html` of this repository before `` and save the file

4. Create a new folder named `betterchat`

5. Copy all contents from `src/` into the newly created folder

6. And you are done! You can now start TeamSpeak

## Configuration ##

BetterChat can be enabled and disabled while TeamSpeak is running.

Just go to the settings menu inside TeamSpeak and navigate to Chats.

There you can toggle specific features, like BBCode support or Rich Embeds, or enable and disable the addon entirely.

![BetterChat Settings](images/settings.png)

## Compatibility ##

| TeamSpeak | Windows | Linux | MacOS |

| --------- | ------- | ----- | ----- |

| Beta 77 | 2.5.0+ | 2.5.0+ | 2.5.0+ |

| Beta 76 | 2.4.0+ | 2.4.0+ | 2.4.0+ |

| Beta 75 | 2.3.0+ | 2.3.0+ | 2.3.0+ |

| Beta 74 | 2.1.0 - 2.2.1 | 2.1.0 - 2.2.1 | 2.1.0 - 2.2.1 |

| Beta 73 | 1.2.0 - 2.2.1 | 1.2.0 - 2.2.1 | 1.2.0 - 2.2.1 |

| Beta 72 | 1.1.0 - 2.2.1 | 1.1.0 - 2.2.1 | n/a |

| Beta 71 | ❌ | ❌ | n/a |

| Beta 70 | 1.0.0 - 1.0.4 | 1.0.0 - 1.0.4 | 1.0.0 - 1.0.4 |