update proxy home page; update readme + todo;

README.md

@@ -12,10 +12,16 @@ Extends Final Fantasy XIV log parsing in Advanced Combat Tracker (ACT) with Lua
 3. Click 'Add/Enable Plugin.'
 4. Click on the 'FFTools' tab. A list of available scripts will be on the left side. Click on a script name and then click the 'Enable' button to enable the script.
 
+- You might get a Windows firewall alert. This is because the ACT plugin launches a seperate application to run the Lua scripts. This application communicates with ACT over an internal network connection.
 
 ## Web View
 
-Some scripts provide a webpage view which provides additonal visual information. These web views can be used in OBS as part of your streaming overlay or can be shared with other players who can't use ACT.
+Some scripts provide a web view which provides additonal visual information. These web views can be used in OBS as part of your streaming overlay or can be shared with other players who can't use ACT. To access the web view just click "Open Web View" while the desired script is selected, it should then open a new browser tab. The link in the browser's address bar can be shared with other players!
+
+### Disable Sharable Web Views
+
+By default web views are made publically available via a proxy to fftools.net. This can be disabled by clicking "Edit Main Plugin Config" and changing the line (in the resulting notepad file that opens) containing `enable_proxy: true` to `enable_proxy: false`.
+Web views will still be available on your local machine at http://localhost:31594. You can also enable port forwarding in your router to share web views without the use of the FFTools proxy.
 
 
 ## Scripting API

TODO

@@ -4,5 +4,13 @@
 - Script repository
 - Auto update more than just daemon exe
 - Reload scripts when config files are changed
-- Recreate original ffliveparse features
-- Overlays
+- Overlays
+- Lua function, 'require', to import other Lua script
+- Lua function, 'enabled_scripts', to list all scripts currently enabled
+- Event, 'act:tts', fires when a text-to-speech message is spoken
+- Lua script, web view, show abilities player used in real time for stream overlays
+- Lua script, web view, TTS passthru, forward all TTS messages to web view, allow user to type their name in so 'fft_say_if' can work
+- Lua script, web view, display other web views in iframes and allow user to place them in a grid
+- Lua script, web view, timeline of current/last encounter (the FFLiveParse timeline view)
+- Lua script, web view, easy to read game log viewer, display combat actions, etc (the FFLiveParse log view)
+- Lua script, web view, graph of DPS/HPS/etc over the course of the current/last encounter (the FFLiveParse graph view)

assets/web/index.html

@@ -9,14 +9,20 @@
             <h1 class="title">
                 <a href="/">FF<span>TOOLS</span></a>
             </h1>
-            <div class="info">Lua scripting in Final Fantasy XIV!</div>
+            <div class="info">Version 0.04</div>
             <div class="icons">
-                <a href="#"><img src="ico_github.png" alt="Github" title="Github" /></a>
-                <a href="#"><img src="ico_discord.png" alt="Discord" title="Discord" /></a>
+                <a href="https://github.com/chompy/fftools"><img src="ico_github.png" alt="Github" title="Github" /></a>
+                <a target="_blank" href="https://discord.gg/6kJ7GKNCCx"><img src="ico_discord.png" alt="Discord" title="Discord" /></a>
             </div>
         </div>
         <div id="body">
-
+            <div class="alert">
+                <strong>Looking for FFLiveParse?</strong> The FFTools ACT plugin contains a 'live parse' web view that provides the same core functionality!
+                Some of the features are missing but I hope to implement them in the future.
+            </div>
+            <div class="section-img">
+                <img src="home_liale.png" alt="Liale Sargatanas" title="I'm absolutely using this as a way to show off my characters :3" />
+            </div>
             <div class="section">
                 <div class="name">About</div>
                 <p>
@@ -27,12 +33,48 @@ <h1 class="title">
                 <p>
                     It offers much of the same functionality of tools like Cactbot and
                     Triggernometry. However, FFTools allows users to install only the scripts they
-                    need and is 100% open source. So you know exactly what you're installing
-                    on your machine.
+                    need and is 100% open source. FFTool's sharable web views also allows sharing
+                    things like damage parses with players who can't run ACT (i.e. console players).
+                </p>
+                    Currently there are only a handful of Lua scripts provided. I hope to expand on that in the future, I have
+                    lots of ideas! Also, as interest increases I hope to release detailed documentation on the scripting API and
+                    further expand what you can do with it.
+                </p>
+            </div>
+            <div class="section">
+                <div class="name">Download</div>
+                <p>
+                    <img src="home_qunara.png" alt="Qunara Excalibur" title="Qunara, part of Tavi's Tavicats!" /><br/>
+                    <a href="https://github.com/chompy/fftools/releases/download/v0.04/fftools.zip">Download ACT Plugin (v0.04)</a> •
+                    <a href="https://github.com/chompy/fftools/blob/main/README.md">Install Guide</a>  •
+                    <a href="https://github.com/chompy/fftools">Github</a>
                 </p>
             </div>
 
 
+            <div class="section">
+                <div class="name">Contact &amp; Donate</div>
+                <p>
+                    <img src="home_minda.png" alt="Minda Sargatanas" title="It's Minda, the famed solo healer!" /><br/>
+                    The best way to reach me is on Discord at <strong>Chompy#3436</strong>.<br/>You can reach me
+                    easilly via the <a target="_blank" href="https://discord.gg/6kJ7GKNCCx">FFTools Discord channel!</a>
+                </p>
+                <p>-</p>
+                <p>
+                    If you like FFTools and use it regularly (particularly the sharable web views) consider donating! It helps offset hosting costs.
+                    <form action="https://www.paypal.com/cgi-bin/webscr" target="_blank" method="post">
+                        <input type="hidden" name="business" value="nathan@ogden.tech">
+                        <input type="hidden" name="cmd" value="_donations">
+                        <input type="hidden" name="item_name" value="FFTools">
+                        <input type="hidden" name="item_number" value="Donation">
+                        <input type="hidden" name="currency_code" value="USD">
+                        <input type="image" name="submit" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="Donate">
+                        <img alt="" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" z6n1eq3xc="" width="1" height="1">
+                    </form>     
+                </p>
+            </div>
+
+
         </div>
     </body>
 </html>

assets/web/main.css

@@ -4,6 +4,9 @@ html, body {
     color: #fff;
     margin: 0;
 }
+a, a:visited, a:hover {
+    color: #fff;
+}
 
 
 /** === HEADER + LOGO === */
@@ -65,6 +68,15 @@ html, body {
     margin: 20px;
 }
 
+/** === ALERT === */
+.alert {
+    background: #3cfc2c;
+    color: #a90000;
+    padding: 15px;
+    font-size: 18px;
+    margin-bottom: 25px;
+}
+
 /** === SECTIONS === */
 .section {
     background-color: #262626;
@@ -80,4 +92,10 @@ html, body {
 }
 .section p {
     text-align: center;
+}
+.section-img {
+    text-align: center;
+}
+form {
+    text-align: center;
 }

config/_app.yaml

@@ -5,7 +5,7 @@
 
 # enable proxy to allow sharing of web views with other people
 # this will make all your web views available at https://proxy.fftools.net/[your id]/[script name]/
-enable_proxy: false
+enable_proxy: true
 
 # port to run web server on for web views, most users should not need to change this
 web_port: 31594