Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hburn7/Brigitta
An IRC chat client made with osu! referees in mind
https://github.com/hburn7/Brigitta
Last synced: 3 months ago
JSON representation
An IRC chat client made with osu! referees in mind
- Host: GitHub
- URL: https://github.com/hburn7/Brigitta
- Owner: hburn7
- Created: 2022-09-19T03:45:32.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T18:48:48.000Z (12 months ago)
- Last Synced: 2024-08-01T19:45:42.758Z (6 months ago)
- Language: HTML
- Homepage:
- Size: 917 KB
- Stars: 20
- Watchers: 4
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-osu-tournaments - Brigitta - IRC client made specifically for tournament referees - primary attraction is detailed interactive display while reffing. (Community Resources / Tools)
README
# Brigitta
Brigitta is an IRC chat client designed specifically for referees of the rhythm game
[osu!](https://osu.ppy.sh/home). *Unfortunately, I do not have the bandwidth to maintain this like I used to. But, plenty of people still choose Brigitta as their client of choice even today. Hope you enjoy!*
# Run The Application
**Prerequisites:**
- [.NET 6.0 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) *Look for ".NET Runtime 6.x.x" on this page*
**Run:**
- Visit the latest [Release](https://github.com/hburn7/Brigitta/releases) and download the .zip file for your platform.
| Platform | Instructions | Special Notes |
|----------|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Windows | Extract the downloaded folder and
run `BrigittaBlazor.exe`. | *None* |
| MacOS | Right click on the "BrigittaBlazor"
executable and click Open. | If you get an error stating that
the executable cannot be run,
please click "Show Finder" and then
`Right Click` -> `Run` any executables
you see. This will need to be done each update. |
| Linux | cd into the downloaded folder
and run `./BrigittaBlazor`. Ensure
it has executable permissions. | *None* |
- All platforms will need to navigate to `localhost:5000` in a browser in order to use the application.
- Checkout my [Discord Server](https://discord.gg/TjH3uZ8VgP) and get the `Brigitta` role in `#roles` to gain special access to developer announcements and know exactly when new releases happen!
## Contributing
Please follow the instructions below when considering making a contribution to the project:
- First and foremost, this is my senior capstone project for my undergraduate degree. I do not expect PRs or any direct code contributions of any kind.
- Please check for any existing issues if you wish to make a PR. I likely will not accept PRs that add additional features without my previous approval.
- Ensure any PRs made have a very detailed description as to what the code does. Ensure all test cases pass.
## Building From Source
**Prerequisites:**
- [.NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
Clone the repo (pick one):
- `git clone https://github.com/hburn7/Brigitta.git`
- `gh repo clone hburn7/Brigitta`
Target and build:
- `cd Brigitta`
- `cd BrigittaBlazor`
- `dotnet run`
## Supplementary Note
If you have concerns, please make an issue on this project and I will respond to it very quickly. I hope you enjoy using Brigitta :)