Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Update README.md * Update README.md
- Loading branch information
1 parent
33c23ea
commit 561458e
Showing
1 changed file
with
125 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,135 @@ | ||
| # BardMusicPlayer | ||
| BardMusicPlayer is an automated music player for playing MIDI songs in FFXIV using the in-game bard performance mode. | ||
| <p align="center"> | ||
| <!-- Build & commit activity --> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/actions/workflows/MERGE-develop.yml"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/BardMusicPlayer/BardMusicPlayer/MERGE-develop.yml?branch=develop&style=for-the-badge" alt="Build"/></a> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/commits/develop"> | ||
| <img src="https://img.shields.io/github/last-commit/BardMusicPlayer/BardMusicPlayer/develop?color=00D162&style=for-the-badge" alt="Commits"/></a> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/commits/develop"> | ||
| <img src="https://img.shields.io/github/commit-activity/m/BardMusicPlayer/BardMusicPlayer?color=00D162&style=for-the-badge" alt="Commit Activity"/></a> | ||
| <br> | ||
| <!-- Other --> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/issues"> | ||
| <img src="https://img.shields.io/github/issues-raw/BardMusicPlayer/BardMusicPlayer?color=EA9C0A&style=for-the-badge" alt="Open Issues"/></a> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/graphs/contributors"> | ||
| <img src="https://img.shields.io/github/contributors/BardMusicPlayer/BardMusicPlayer?color=009009&style=for-the-badge" alt="Contributors"/></a> | ||
| <a href="https://discord.gg/bmp"> | ||
| <img src="https://img.shields.io/discord/476802720922206209?color=5865F2&label=&logo=Discord&logoColor=ffffff&style=for-the-badge" alt="Discord"/></a> | ||
| <br> | ||
| <!-- Version --> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/releases/tag"> | ||
| <img src="https://img.shields.io/github/v/tag/BardMusicPlayer/BardMusicPlayer?label=Release&logo=git&logoColor=ffffff&style=for-the-badge" alt="Release"/></a> | ||
| </p> | ||
|
|
||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li><a href="#about">About BardMusicPlayer</a></li> | ||
| <li><a href="#plugin">Hypnotoad Plugin</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| <li><a href="#usage">Using Hypnotoad </a></li> | ||
| </ul></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| For further information or a quick start, visit the [official page](https://bardmusicplayer.com/). | ||
| <section id="about"> | ||
|
|
||
| # About BardMusicPlayer | ||
| <p> BardMusicPlayer is an automated music player for playing MIDI songs in FFXIV using the in-game bard performance mode. | ||
| For further information or a quick start, visit the <a href="https://bardmusicplayer.com/">official page</a>.</p> | ||
|
|
||
| **Join the ✅ [Discord Server](https://discord.gg/bmp) for support!** | ||
| <p align="left"> | ||
| <a href="https://discord.gg/bmp"> | ||
| <img src="https://discord.com/api/guilds/476802720922206209/widget.png" alt="Discord"> | ||
| </a> | ||
| </p> | ||
| </section> | ||
|
|
||
| <section id="plugin"> | ||
|
|
||
| # Hypnotoad Plugin | ||
| BardMusicPlayer can be used with the <a href="https://github.com/BardMusicPlayer/Hypnotoad-Plugin">Hypnotoad</a> companion plugin for enhanced functionality. | ||
|
|
||
| <details> | ||
| <summary>Enhanced Features</summary> | ||
|
|
||
| * Output lyrics. | ||
| * Chat while performing. | ||
| * Direct instrument open & close. | ||
| * Direct ensemble ready / accept. | ||
| * Improved note playing. | ||
| * Set graphics toggle. | ||
|
|
||
| And much more! | ||
| </details> | ||
| </section> | ||
|
|
||
| <section id="prerequisites"> | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| * Install <a href="https://www.finalfantasyxiv.com/" alt="Final Fantasy XIV">Final Fantasy XIV</a> | ||
| * Install <a href="https://github.com/goatcorp/FFXIVQuickLauncher#how-to-install-the-launcher" alt="XIVLauncher">XIVLauncher</a> | ||
| * Add the custom <a href="#installation" alt="repository">repository</a> | ||
| </section> | ||
|
|
||
| <section id="installation"> | ||
|
|
||
| ### Installation | ||
| * Copy the following repository link: <br> | ||
| `https://dl.bardmusicplayer.com/hypnotoad/` <br><br> | ||
| * Type `/xlsettings` in the game chat window to open the Dalamud Settings. | ||
| * Navigate to the "Experimental" tab. | ||
| <br><br><a><img src="https://i.imgur.com/FDlwtbe.png" /></a><br><br> | ||
| * Paste the link copied into the available input box under "Custom Plugin Repositories". | ||
| * Ensure the box to the right of the link is checked. | ||
| <br><br><a><img src="https://i.imgur.com/eSGDKYT.png" height="180" /></a><br><br> | ||
| * Press the "Save changes & close" icon in the bottom right of the settings window. | ||
| * Navigate to the "All Plugins" tab inside the `/xlplugins` plugin browser and search for `HypnotoadPlugin`. | ||
| * Click on "HypnotoadPlugin" and select "Install". | ||
| * The companion plugin is now ready to be used. | ||
| </section> | ||
|
|
||
|
|
||
| <section id="usage"> | ||
|
|
||
| ### Using Hypnotoad | ||
| To enable all enhanced functionality, simply checkmark the "Hypnotoad Compatibility" option inside BardMusicPlayer's Settings tab. | ||
| <br><br><a><img src="https://i.imgur.com/j9HWfZV.png" alt="Settings"/></a><br> | ||
| </section> | ||
|
|
||
| <section id="contributing"> | ||
|
|
||
| # Contributing | ||
| Contributions to the project are more than welcome - please feel free to submit a [pull request](https://github.com/BardMusicPlayer/BardMusicPlayer/pulls) here on GitHub and reach out on the [Discord Server](https://discord.gg/bmp) so we can communicate any necessary changes and review your submission! | ||
| </section> | ||
|
|
||
| # | ||
|
|
||
| <p align="center"> | ||
| <br> Brought to you by: <br><br> | ||
|
|
||
| <a href="https://github.com/troy-f"> | ||
| <img src="https://avatars.githubusercontent.com/u/69164391?v=4" width="40" style="border-radius:50%" alt="troy-f"/></a> | ||
|
|
||
| <a href="https://github.com/GiR-Zippo"> | ||
| <img src="https://avatars.githubusercontent.com/u/324273?v=4" width="40" style="border-radius:50%" alt="GiR-Zippo"/></a> | ||
|
|
||
| <a href="https://github.com/parulina"> | ||
| <img src="https://avatars.githubusercontent.com/u/6361957?v=4" width="40" style="border-radius:50%" alt="parulina"/></a> | ||
|
|
||
| BardMusicPlayer can be used in conjunction with the [Hypnotoad](https://github.com/BardMusicPlayer/Hypnotoad-Plugin) dalamud companion plugin for enhanced functionality. | ||
| <a href="https://github.com/trotlinebeercan"> | ||
| <img src="https://avatars.githubusercontent.com/u/1673591?v=4" width="40" style="border-radius:50%" alt="trotlinebeercan"/></a> | ||
|
|
||
| * Output lyrics. | ||
| * Chat while playing. | ||
| * Direct instrument & ensemble ready / accept. | ||
| * Set graphics toggle. | ||
| <a href="https://github.com/sabihoshi"> | ||
| <img src="https://avatars.githubusercontent.com/u/25006819?v=4" width="40" style="border-radius:50%" alt="sabihoshi"/></a> | ||
|
|
||
| ## How to Install | ||
| <a href="https://github.com/isaki"> | ||
| <img src="https://avatars.githubusercontent.com/u/10616227?v=4" width="40" style="border-radius:50%" alt="isaki"/></a> | ||
|
|
||
| Copy this url to your dalamud settings experimental custom plugin repositories and search for the hypnotoad plugin. | ||
| <a href="https://github.com/sammhill"> | ||
| <img src="https://avatars.githubusercontent.com/u/18413733?v=4" width="40" style="border-radius:50%" alt="sammhill"/></a> | ||
|
|
||
| `https://dl.bardmusicplayer.com/hypnotoad/` | ||
| <a href="https://github.com/Meowchestra"> | ||
| <img src="https://avatars.githubusercontent.com/u/42126400?v=4" width="40" style="border-radius:50%" alt="Meowchestra"/></a> | ||
| <br><br> | ||
| <a href="https://github.com/BardMusicPlayer/BardMusicPlayer/graphs/contributors">～ and many others ～</a> | ||
| </p> |