-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
207 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,216 +1,20 @@ | ||
<section id="top"> | ||
<!-- Project Logo --> | ||
<p style="text-align:center;" align="center"><img align="center" src="/res/readme_images/top-logo.png" width="900" /><br></p> | ||
</section> | ||
|
||
<!-- Badges --> | ||
<p align="center"> | ||
<!-- Build & commit activity --> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/actions/workflows/build.yml" alt="Build"> | ||
<img src="https://img.shields.io/github/actions/workflow/status/Nik-Potokar/XIVSlothCombo/build.yml?branch=main&style=for-the-badge" /></a> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/commits/main" alt="Commits"> | ||
<img src="https://img.shields.io/github/last-commit/Nik-Potokar/XIVSlothCombo/main?color=00D162&style=for-the-badge" /></a> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/commits/main" alt="Commit Activity"> | ||
<img src="https://img.shields.io/github/commit-activity/m/Nik-Potokar/XIVSlothCombo?color=00D162&style=for-the-badge" /></a> | ||
<a href="https://github.com/PunishXIV/WrathCombo/commits/main" alt="Commits"> | ||
<img src="https://img.shields.io/github/last-commit/PunishXIV/WrathCombo/main?color=00D162&style=for-the-badge" /></a> | ||
<a href="https://github.com/PunishXIV/WrathCombo/commits/main" alt="Commit Activity"> | ||
<img src="https://img.shields.io/github/commit-activity/m/PunishXIV/WrathCombo?color=00D162&style=for-the-badge" /></a> | ||
<br> <!-- Other --> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/issues" alt="Open Issues"> | ||
<img src="https://img.shields.io/github/issues-raw/Nik-Potokar/XIVSlothCombo?color=EA9C0A&style=for-the-badge" /></a> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/graphs/contributors" alt="Contributors"> | ||
<img src="https://img.shields.io/github/contributors/Nik-Potokar/XIVSlothCombo?color=009009&style=for-the-badge" /></a> | ||
<a href="https://github.com/PunishXIV/WrathCombo/issues" alt="Open Issues"> | ||
<img src="https://img.shields.io/github/issues-raw/PunishXIV/WrathCombo?color=EA9C0A&style=for-the-badge" /></a> | ||
<a href="https://github.com/PunishXIV/Wrath Combo/graphs/contributors" alt="Contributors"> | ||
<img src="https://img.shields.io/github/contributors/PunishXIV/WrathCombo?color=009009&style=for-the-badge" /></a> | ||
<a href="https://discord.gg/Zzrcc8kmvy" alt="Discord"> | ||
<img src="https://img.shields.io/discord/1001823907193552978?color=5865F2&label=&logo=Discord&logoColor=ffffff&style=for-the-badge" /></a> | ||
<br> <!-- Version --> | ||
<a href="https://github.com/Nik-Potokar/XIVSlothCombo/tags" alt="Release"> | ||
<img src="https://img.shields.io/github/v/tag/Nik-Potokar/XIVSlothCombo?label=Release&logo=git&logoColor=ffffff&style=for-the-badge" /></a> | ||
<a href="https://github.com/PunishXIV/Wrath Combo/tags" alt="Release"> | ||
<img src="https://img.shields.io/github/v/tag/PunishXIV/WrathCombo?label=Release&logo=git&logoColor=ffffff&style=for-the-badge" /></a> | ||
</p> | ||
|
||
# | ||
<!-- Contents Table --> | ||
<details> | ||
<summary>Table of Contents</summary> | ||
<ol> | ||
<li><a href="#about">About XIVSlothCombo</a></li> | ||
<li><a href="#getting-started">Getting Started</a> | ||
<ul> | ||
<li><a href="#prerequisites">Prerequisites</a></li> | ||
<li><a href="#installation">Installation</a></li> | ||
<li><a href="#usage">Using XIVSlothCombo (coming soon)</a></li> | ||
<li><a href="#commands">Commands</a></li> | ||
</ul></li> | ||
<li><a href="#features">Features</a></li> | ||
<li><a href="#contributing">Contributing</a></li> | ||
</ol> | ||
</details> | ||
|
||
<!-- About XIVSlothCombo --> | ||
<section id="about"> | ||
<a href="#about" alt="About"><img src="/res/readme_images/About.png" height="60px" /></a> | ||
<p> XIVSlothCombo is a plugin for <a href="https://goatcorp.github.io/" alt="XIVLauncher">XIVLauncher</a>.<br><br> | ||
It's a heavily enhanced version of the XIVCombo plugin, offering highly customisable features and options to provide users with a combo set as simple or complex as desired; for PvE, PvP and more.<br><br> | ||
XIVSlothCombo is regularly updated to include new features and to keep up-to-date with the latest job changes in Final Fantasy XIV. | ||
</section> | ||
|
||
<!-- Getting Started --> | ||
<section id="getting-started"> | ||
<a href="#getting-started" alt="Getting Started"><img src="/res/readme_images/Getting%20Started.png" height="60px" /></a> | ||
</section> | ||
|
||
<!-- Prerequisites --> | ||
<section id="prerequisites"> | ||
<a href="#prerequisites" alt="Prerequisites"><img src="/res/readme_images/Prerequisites.png" height="50px" /></a> | ||
|
||
* 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> <br> | ||
|
||
<!-- Installation --> | ||
<section id="installation"> | ||
<a href="#installation" alt="Installation"><img src="/res/readme_images/Installation.png" height="50px" /></a> | ||
|
||
* Copy the following repository link: <br> | ||
`https://raw.githubusercontent.com/Nik-Potokar/MyDalamudPlugins/main/pluginmaster.json` <br><br> | ||
* Type `/xlsettings` in the game chat window to open the Dalamud Settings window. | ||
* Navigate to the "Experimental" tab. | ||
<br><br><a><img src="/res/readme_images/experimental_tab.png" width="300" /></a><br><br> | ||
* Paste the link you 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="/res/readme_images/adding_repo.png" height="150" /></a><br><br> | ||
* Press "Save and Close" at the bottom of the settings window. <br> You may notice the list of plugins flash briefly on the installer window - this just signifies the list refreshing successfully. | ||
* Navigate to the "All Plugins" tab and scroll to the bottom of the plugin list. | ||
* Click on "XIVSlothCombo" and select "Install". | ||
* Click on the settings cog (where you just clicked "Install") to open the configuration. <br> | ||
Alternatively, type `/scombo` in the game chat window. | ||
</section> <br> | ||
|
||
<!-- Using XIVSlothCombo --> | ||
<section id="usage"> | ||
<a href="#usage" alt="Using the Plugin"><img src="/res/readme_images/Using%20XIVSlothCombo.png" height="50px" /></a> | ||
<p> Coming soon... </p> | ||
<p align="right"><a href="#top" alt="Back to top"><img src=/res/readme_images/arrowhead-up.png width ="25"/></a></p> | ||
</section> | ||
|
||
<!-- Commands --> | ||
<section id="commands"> | ||
<a href="#commands" alt="Commands"><img src="/res/readme_images/Commands.png" height="50px" /></a> | ||
|
||
|
||
| **Chat command ** | **Function** | | ||
| :----------------- |:------------------ | | ||
| `/scombo`| Opens the main plugin window, where you can enable/disable features, access settings and more.| | ||
| `/scombo set`| Turns a specific feature/option **on** by referring to its internal name.<br>Does not work when in combat.| | ||
| `/scombo unset`| Turn a specific feature/option **off** by referring to its internal name.<br>Does not work while in combat.| | ||
| `/scombo unsetall`| Turns all features and options **off** at once.| | ||
| `/scombo toggle`| Toggles a specific feature/option **on or off** by referring to its internal name.<br>Does not work while in combat.| | ||
| `/scombo list`| Prints lists to the game chat based on filter arguments. <br>Requires an appended filter.| | ||
| `/scombo list set`<br>`/scombo enabled`| Prints a list of all currently enabled features & options in the game chat.| | ||
| `/scombo list unset`| Prints a list of all currently disabled features & options in the game chat.| | ||
| `/scombo list all`| Prints a list of every feature & option in the game chat, regardless of state.| | ||
| `/scombo debug`| Outputs a full debug file to your desktop that can be sent to developers for utilisation in bug-fixing.| | ||
| `/scombo debug JOB`| Outputs a debug file to your desktop containing only job-relevant features/options. <br>Replace `JOB` with the appropriate job abbreviation.| | ||
|
||
<p align="right"><a href="#top" alt="Back to top"><img src=/res/readme_images/arrowhead-up.png width ="25"/></a></p> | ||
</section> | ||
|
||
<!-- Features --> | ||
<section id="features"> | ||
<a href="#features" alt="Features"><img src="/res/readme_images/Features.png" height="60px" /></a> | ||
|
||
Below you can find a small example of some of the features and options we offer in XIVSlothCombo. <br> | ||
Please note, this is just an excerpt and is not representative of the full feature-set. | ||
|
||
|
||
<details><summary>PvE Features</summary> <br> | ||
|
||
Tank Double Reprisal Protection | ||
Tank Interrupt Feature | ||
Healer Raise Feature | ||
Magical Ranged DPS Double Addle Protection | ||
Magical Ranged DPS Raise Feature | ||
Melee DPS Double Feint Protection | ||
Melee DPS True North Protection | ||
Physical Ranged DPS Double Mitigation Protection | ||
Physical Ranged DPS Interrupt Feature | ||
|
||
"Simple Mode" for many jobs | ||
"Advanced Mode" for many jobs | ||
Variant Dungeon specific features (Bozja/Eureka coming soon) | ||
|
||
And much more! | ||
|
||
</details> | ||
|
||
<details><summary>PvP Features</summary> <br> | ||
|
||
"Burst Mode" offense features for all jobs | ||
Emergency Heals | ||
Emergency Guard | ||
Quick Purify | ||
Guard Cancellation Prevention | ||
|
||
And much more! | ||
|
||
</details> | ||
|
||
<details><summary>Miscellaneous Features</summary> <br> | ||
|
||
Island Sanctuary Sprint Feature | ||
[BTN/MIN] Eureka Feature | ||
[BTN/MIN] Locate & Truth Feature | ||
[FSH] Cast to Hook Feature | ||
[FSH] Diving Feature | ||
|
||
And much more! | ||
|
||
</details> | ||
|
||
To experience the full set of features on offer, <a href="#installation" alt="install">install</a> the plugin or visit the [Discord](https://discord.gg/punishxiv) server for more info. | ||
|
||
<p align="right"><a href="#top" alt="Back to top"><img src=/res/readme_images/arrowhead-up.png width ="25"/></a></p> | ||
</section> | ||
|
||
<!-- Contributing --> | ||
<section id="contributing"> | ||
<a href="#contributing" alt="Contributing"><img src="/res/readme_images/Contributing.png" height="60px" /></a> | ||
|
||
Contributions to the project are always welcome - please feel free to submit a [pull request](https://github.com/Nik-Potokar/XIVSlothCombo/pulls) here on GitHub, but ideally get in contact with us over on the [Discord](https://discord.gg/punishxiv) server so we can communicate with one another to make any necessary changes and review your submission! | ||
|
||
<p align="right"><a href="#top" alt="Back to top"><img src=/res/readme_images/arrowhead-up.png width ="25"/></a></p> | ||
</section> | ||
|
||
# | ||
<!-- Team Sloth Dev Links --> | ||
<p align="center"> | ||
<br> Brought to you by: <br><br> | ||
<img align="center" src="/res/team_sloth_images/team-sloth.png" width="700" /><br><br> | ||
|
||
<a href="https://github.com/Nik-Potokar" alt="Aki"> | ||
<img src="/res/team_sloth_images/Members/Aki.png" width="40" /></a> | ||
|
||
<a href="https://github.com/k-kz" alt="k-kz"> | ||
<img src="/res/team_sloth_images/Members/k-kz.png" width="40" /></a> | ||
|
||
<a href="https://github.com/ele-starshade" alt="ele-starshade"> | ||
<img src="/res/team_sloth_images/Members/ele-starshade.png" width="40" /></a> | ||
|
||
<a href="https://github.com/damolitionn" alt="damolitionn"> | ||
<img src="/res/team_sloth_images/Members/damolitionn.png" width="40" /></a> | ||
|
||
<a href="https://github.com/Taurenkey" alt="Taurenkey"> | ||
<img src="/res/team_sloth_images/Members/Taurenkey.png" width="40" /></a> | ||
|
||
<a href="https://github.com/augporto" alt="Augporto"> | ||
<img src="/res/team_sloth_images/Members/Augporto.jpg" width="40" /></a> | ||
|
||
<a href="https://github.com/grimgal" alt="grimgal"> | ||
<img src="/res/team_sloth_images/Members/grimgal.png" width="40" /></a> | ||
|
||
<a href="https://github.com/Genesis-Nova" alt="Genesis-Nova"> | ||
<img src="/res/team_sloth_images/Members/Genesis-Nova.png" width="40" /></a> | ||
|
||
<a href="https://github.com/Tartarga" alt="Tartarga"> | ||
<img src="/res/team_sloth_images/Members/Tartarga.png" width="40" /></a> | ||
<br><br> | ||
And many other <a href="https://github.com/Nik-Potokar/XIVSlothCombo/graphs/contributors" alt="Contributors">contributors</a>! | ||
</p> | ||
NEW README UNDER CONSTRUCTION |