Skip to content

Commit

Permalink
readme: move overlay plugin instructions below what they are
Browse files Browse the repository at this point in the history
  • Loading branch information
@quisquous
quisquous committed Oct 4, 2017
1 parent 4209cf8 commit 6fb6bf7
Showing 1 changed file with 29 additions and 31 deletions.
60 changes: 29 additions & 31 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,37 +26,6 @@ that anybody would need to write a good Javascript UI for
The [ui/](ui/) directory has some prebuilt UI modules, and the [resources/](resources/) directory has
building blocks for building your own modules.

### Adding overlay modules (example: raidboss)

To add a cactbot module is the same as adding any overlay plugin.
1. Open ACT.
2. Navigate to the Plugins tab of ACT and then the OverlayPlugin.dll tab inside it.

![overlay plugin tab screenshot](screenshots/OverlayPluginTab.png)

3. Click the "New" button and then select Cactbot in the "Type" dropdown.

![new overlay plugin screenshot](screenshots/OverlayPluginNew.png)

4. Type in any name you'd like as the name of this overlay, e.g. `raidbossy`.
5. A good example to start with is the raidboss module. Set the filename to be **ui/raidboss/raidboss.html**. Your config should look like this.

![raidboss plugin config](screenshots/OverlayPluginRaidbossConfig.png)

6. At this point, you should see some bunched up test UI appear on screen.

![raidboss plugin sizing](screenshots/OverlayPluginRaidbossSizing.png)

7. Click the **Enable Clickthru** button on the config panel. Then, in FFXIV, click and drag the lower right corner of the raidboss overlay to resize it. Click and drag anywhere else on the raidboss overlay to move it. This will make it look a lot better. You can [configure this with CSS](#configuring-ui-modules) if you want even more control. It should look something like this:

![raidboss plugin final](screenshots/OverlayPluginRaidbossFinalSize.png)

8. Once the overlay is in the right place, click the **Lock Overlay** and unclick **Enable Clickthru**. Now you're ready for [cactbot magic](https://clips.twitch.tv/StrangeHungryGarageShadyLulu).

9. If you want to test the raidboss plugin, teleport to Summerford Farms, and follow [these instructions](ui/raidboss/data/timelines/test.txt).

The modules in [ui/](ui/) are:

### [raidboss](ui/raidboss) module

To use this module, point cactbot at **ui/raidboss/raidboss.html**.
Expand Down Expand Up @@ -123,6 +92,35 @@ the timelines were added to raidboss:

[![Exdeath video](screenshots/ExdeathVideo.png)](https://www.youtube.com/watch?v=Ot_GMEcwv94)

### Adding overlay modules (example: raidboss)

To add a cactbot module is the same as adding any overlay plugin.
1. Open ACT.
2. Navigate to the Plugins tab of ACT and then the OverlayPlugin.dll tab inside it.

![overlay plugin tab screenshot](screenshots/OverlayPluginTab.png)

3. Click the "New" button and then select Cactbot in the "Type" dropdown.

![new overlay plugin screenshot](screenshots/OverlayPluginNew.png)

4. Type in any name you'd like as the name of this overlay, e.g. `raidbossy`.
5. A good example to start with is the raidboss module. Set the filename to be **ui/raidboss/raidboss.html**. Your config should look like this.

![raidboss plugin config](screenshots/OverlayPluginRaidbossConfig.png)

6. At this point, you should see some bunched up test UI appear on screen.

![raidboss plugin sizing](screenshots/OverlayPluginRaidbossSizing.png)

7. Click the **Enable Clickthru** button on the config panel. Then, in FFXIV, click and drag the lower right corner of the raidboss overlay to resize it. Click and drag anywhere else on the raidboss overlay to move it. This will make it look a lot better. You can [configure this with CSS](#configuring-ui-modules) if you want even more control. It should look something like this:

![raidboss plugin final](screenshots/OverlayPluginRaidbossFinalSize.png)

8. Once the overlay is in the right place, click the **Lock Overlay** and unclick **Enable Clickthru**. Now you're ready for [cactbot magic](https://clips.twitch.tv/StrangeHungryGarageShadyLulu).

9. If you want to test the raidboss plugin, teleport to Summerford Farms, and follow [these instructions](ui/raidboss/data/timelines/test.txt).

## Configuring UI modules

Cactbot UI modules can load user settings from the [user/](user/) directory. Simply create
Expand Down

9 comments on commit 6fb6bf7

@knall
Copy link

@knall knall commented on 6fb6bf7 Oct 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The down side to this is that your dependency isn't updated and is not working so your project is not working. Do you have any suggestions on alternatives? I would absolutely love to have a working setup using your overlay but the hibiyasleep version is not being actively updated making your version not work. I also noticed even with the hibiyasleep version I am not seeing the FFXIV_ACT_Plugin.dll. The folder structure in this help file also differs from that in your download.

@quisquous
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! I'm a little unclear what you're reporting as a problem here. Are you saying that hibiyasleep isn't working for you so cactbot isn't working for you? Does using the prebuilt hibiyasleep overlay plugin from this link not work for you?

Re: folder structure. The folder structure has been the same in all of the releases so far. The listing in the installation instructions is what the final directory structure should look like after you copy the OverlayPlugin directory from the release zip file into your ACT folder. Is the confusion that the release doesn't include OverlayPlugin*.dll?

If you're having trouble with installation, can you open an issue: https://github.com/quisquous/cactbot/issues/new? I'll be happy to try to work through whatever problems you're running into. :)

@knall
Copy link

@knall knall commented on 6fb6bf7 Oct 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

correct, it does not work. Attaching an example. You will see that the default plugin will show data while the hibiyasleep does not report data. prior to configuring the overlay the base reports that it can't read from memory, so I am assuming they have not updated the new memory locations. Then they haven't updated since august so that is expected with the update to the game that broke everything.

The folders seem different to me, If possible maybe we can discuss?

example

@quisquous
Copy link
Owner Author

@quisquous quisquous commented on 6fb6bf7 Oct 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hibiyasleep OverlayPlugin doesn't need to update memory signatures because it uses the ACT api directly. Here's some debugging questions:

(1) What dps overlay are you using? I'm not sure I recognize that one.
(2) Can you show me what your OverlayPlugin tab looks like and what settings you're using for the parser?
(3) Do other cactbot pages work (e.g. raidboss, test) with cactbot?
(4) Are you saying your dps plugin doesn't work with the hibiyasleep "miniparse" or that it doesn't work with "cactbot"? Regardless, can you let me know and try the opposite and see if it changes anything.

I'm still not sure I understand the issue with the folder structure. The release folder only comes with an OverlayPlugin folder with some things inside of it. It expects that you already have the Advanced Combat Tracker.exe (from ACT), FFXIV_ACT_Plugin.dll (from ravahn), and OverlayPlugin*.dll files (from hibiyasleep). What do you expect the folder structure to look like or contain?

@knall
Copy link

@knall knall commented on 6fb6bf7 Oct 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First from your instructions
5) Copy the OverlayPlugin\ folder from inside of the unzipped folder on top of your existing C:...\Advanced Combat Tracker\OverlayPlugin\ folder.

There is no Overlay folder, there is a CactbotOverlay. I assume you mean this, but that is a difference, and you can't copy it over, you have to copy the contents, assuming you did the folder structure would be nothing like the one depicted in the instructions.
folderstruct1
From the link you gave me, the zip file contents
folderstruct2

I did eventually get Hibiyasleep overlayplugin to work. It took purging everything and starting over from scratch but its working, kind of. Both the default (ravahn) and Hibiyasleep miss a LOT of data right now for some reason but that is likely another story all together. Still though, the ffxiv_act_plugin.dll is not there. I am using the default plugin (the one from ravahn) which is odd.
ravahn version

According to you I should have a completely different structure, containing a number of different files.

As far as your question does any of the other parts work. Well I can't get it to compile because I am missing dependencies I can't test.

@knall
Copy link

@knall knall commented on 6fb6bf7 Oct 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized I am a complete idiot, and I missed the compiled release version sitting there.

I am sorry. I will work with the release version and get back to you on that one. I also realized where ffxiv overlay is. apparently it was stuck in the appdata folder rather than the application folder.

@quisquous
Copy link
Owner Author

@quisquous quisquous commented on 6fb6bf7 Oct 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re: missing data. I think you need to be more clear about what you mean by missing data. You should definitely make sure that you don't have "disable parsing from network data" checked in FFXIV Settings. That said, I'm not sure I can really help you. That's really an overlay plugin or ffxiv plugin issue though (and not a cactbot one) if it's something like that. If your dps meter works with miniparse but not with cactbot, that's something I can look into.

Re: folder structure. The ffxiv_act_plugin.dll is something you need to add to your ACT folder yourself and isn't something that cactbot will give you.

@knall
Copy link

@knall knall commented on 6fb6bf7 Oct 26, 2017 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@quisquous
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad you got it all sorted! If you have any issues with cactbot itself, please file bugs via this link.

Re: timeline. I think you could write a cactbot module that listened to triggers and made a log of events if that was something that you wanted to do. I think that's pretty reasonable to write if you wanted to do it.

Re: memory locations. I wish the act plugin also had more memory locations too, but I can understand why they probably don't want to add more things they have to update every release.

Please sign in to comment.