Simple overlay chat app built with .NET winforms
Report Bug
·
Request Feature
Table of Contents
Simple overlay chat app built with .NET winforms
- Clone the repo
git clone https://github.com/necoarcc/brehchat
- Build the solution
dotnet build
Brehchat can overlay over almost any window (except one that is exclusive fullscreen), so you can use it to add chat features to any application it will be handy with. With one keypress, you can focus on Brehchat and chat with whoever you need to.
- Download a prebuilt executable or build the server yourself
- Write a tokens.json (tokens are like passwords for individual users tied to usernames), the format is json, and should look as follows:
[ [ "token1", "username1" ], [ "token2", "username2" ], ... ]
- Optionally, write a prefixes.cfg. The format is plaintext, one prefix per line. You can also pass prefixes as a command argument as so:
The default prefix, if none specified, is
path/to/server http://prefix1/ http://prefix2/
http://localhost:3062 - Currently, the server doesn't support directly adding ssl certificates, but the client won't connect to insecure remote hosts, so you will have to set up a reverse proxy with HTTPS termination that supports WebSockets. If you have a domain on Cloudflare, you can use Cloudflare Tunnel for free.
- Run the server!
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Made with contrib.rocks.
Distributed under the MIT. See LICENSE for more information.
Project Link: https://github.com/necoarcc/brehchat