Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 4.22 KB

README.md

File metadata and controls

72 lines (43 loc) · 4.22 KB

icon

FFXIV FATE/Map Gil Tracker

Dynamic XML Badge License GitHub Workflow Status (with event) Dalamud Repo

This plugin aims to simplify reward tracking for FCs who use FATEs/Maps as fundraising events! Simply install it, enable it, and it'll automatically track every chest or sack opened and calculate how much gil each person owes.

Screenshots

image1 image2

Installation

As of writing, this plugin is still in testing and not yet available on the general Dalamud plugin repo. That said, there are two ways you can install test builds onto your client.

Dalamud Testing Repo - Public Betas

As of now, the most official method of installation is via Dalamud's testing channel. Versions distributed via this method are reviewed, tested, and approved by the Dalamud devs, but there still might be some bugs in your experience.

To install a public beta, open the Dalamud Plugin Installer's settings, and under the "Experimental" tab, enable testing builds. After saving, closing, then reopening the installer, the plugin should now be visible in the new "Testing Available" section of the sidebar.

Third-Party Repo - Public Alphas

If you feel like living on the edge and would like to test new features the second they become available, you can install the public alpha via my third-party repo. Versions distributed via this method are generally tested by myself, but because they're only reviewed by one person, are bound to be buggy and may potentially crash your game. Tread lightly!

You can find the page for my repo, which contains instructions on how to use it, here or by clicking on the repo card below.

Card

Development

In order to set up a development environment to work on this plugin, perform the following steps:

  1. Install Visual Studio Code 2022 with C# support
  2. Fork this repo to your account, then clone it to your local machine
  3. Open MapGilTracker.sln in VS2022 and build it
  4. In Dalamud, open the Plugin Installer settings menu
  5. Under the "Experimental" tab, add the full path to the compiled debug DLL under "Dev Plugin Locations"
  6. Profit? (Heh.)

Contributions

Contributions are welcome! I respectfully ask that you follow the contribution guidelines for this project, located in CONTRIBUTING.md. Here's the TL;DR:

  • Pull Requests should be opened against develop. Any PRs opened against master will be denied.
  • If adding a feature, name your branch using the following pattern: f/[short-name].
  • If patching a bug, name your branch using the following pattern: b/[issue-#]-[short-name].
    • If there is no issue associated with the bug you're fixing, please open one before submitting your PR.

License

Distributed under the GNU General Public License v3.0 license. See LICENSE.md for more details.

Acknowledgements

I'd like to say thanks to a few people/teams who have made developing this project a very rewarding experience!

  • The Dalamud Team - For making and maintaining the Dalamud project, and also being helpful throughout the entire development process
  • Azure Infinitum - My FC, who gave me the idea to start this project
  • MajorPainOG - For being my primary tester and for helping me design much of this plugin