From 561458ea13089e4a07c73bc167face6d5ab98c72 Mon Sep 17 00:00:00 2001 From: Meowchestra <42126400+Meowchestra@users.noreply.github.com> Date: Sun, 22 Jan 2023 08:05:22 -0800 Subject: [PATCH] Prettify Readme (#212) * Update README.md * Update README.md * Update README.md --- README.md | 141 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 125 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e1b3cc7a..aa357ed0 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,135 @@ -# BardMusicPlayer -BardMusicPlayer is an automated music player for playing MIDI songs in FFXIV using the in-game bard performance mode. +

+ + + Build + + Commits + + Commit Activity +
+ + + Open Issues + + Contributors + + Discord +
+ + + Release +

+ +
+ Table of Contents +
    +
  1. About BardMusicPlayer
    2. +
  2. Hypnotoad Plugin +
    3. +
  3. Contributing
    4. +
+
-For further information or a quick start, visit the [official page](https://bardmusicplayer.com/). +
+ +# About BardMusicPlayer +

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 official page.

**Join the ✅ [Discord Server](https://discord.gg/bmp) for support!** -

- - Discord - -

+
+ +
# Hypnotoad Plugin +BardMusicPlayer can be used with the Hypnotoad companion plugin for enhanced functionality. + +
+Enhanced Features + + * Output lyrics. + * Chat while performing. + * Direct instrument open & close. + * Direct ensemble ready / accept. + * Improved note playing. + * Set graphics toggle. + + And much more! +
+
+ +
+ +### Prerequisites + +* Install Final Fantasy XIV +* Install XIVLauncher +* Add the custom repository +
+ +
+ +### Installation +* Copy the following repository link:
+ `https://dl.bardmusicplayer.com/hypnotoad/`

+* Type `/xlsettings` in the game chat window to open the Dalamud Settings. +* Navigate to the "Experimental" tab. +



+* Paste the link copied into the available input box under "Custom Plugin Repositories". +* Ensure the box to the right of the link is checked. +



+* 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. +
+ + +
+ +### Using Hypnotoad +To enable all enhanced functionality, simply checkmark the "Hypnotoad Compatibility" option inside BardMusicPlayer's Settings tab. +

Settings
+
+ +
+ +# 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! +
+ +# + +

+
Brought to you by:

+ + + troy-f + + + GiR-Zippo + + + parulina -BardMusicPlayer can be used in conjunction with the [Hypnotoad](https://github.com/BardMusicPlayer/Hypnotoad-Plugin) dalamud companion plugin for enhanced functionality. + + trotlinebeercan -* Output lyrics. -* Chat while playing. -* Direct instrument & ensemble ready / accept. -* Set graphics toggle. + + sabihoshi -## How to Install + + isaki -Copy this url to your dalamud settings experimental custom plugin repositories and search for the hypnotoad plugin. + + sammhill -`https://dl.bardmusicplayer.com/hypnotoad/` + + Meowchestra +

+ ～ and many others ～ +

\ No newline at end of file