bump version

This reverts commit 56b053fc7f.

CONTRIBUTING.MD

@@ -0,0 +1,141 @@
+# How to contribute
+
+All meaningful contributions are welcome. If you're not sure about something,
+open an issue or [join the discord server](https://discord.youhavetrouble.me/)
+to talk it out.
+
+## Reporting issues
+
+If you find a bug or unexpected behavior, open an issue. Include information about
+how to reproduce the issue, and any relevant error messages from your browser's
+console.
+
+## Pull requests
+PLEASE OPEN AN ISSUE OR DISCUSS ON DISCORD BEFORE MAKING A PULL REQUEST.
+
+Noone likes to waste time on a PR that won't be accepted, so please ask first!
+
+## Inputting data
+
+Entire project is data-driven and contributions can be made either via pull request or
+submitting a json file with the data formatted as described below. If anything's unclear,
+[ask on discord](https://discord.youhavetrouble.me/).
+
+### Items
+You can see the existing data [here](https://github.com/YouHaveTrouble/DiscipleOfLand/blob/master/public/data/items.json).
+Item data adheres to following json schema:
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "patternProperties": {
+    "^[a-zA-Z0-9-]+$": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string" },
+        "level": { "type": "integer" },
+        "stars": { "type": "integer" },
+        "perception": { "type": "integer" }
+      },
+      "required": ["name", "level"]
+    }
+  },
+  "additionalProperties": false
+}
+
+```
+
+### Zones
+You can see the existing data [here](https://github.com/YouHaveTrouble/DiscipleOfLand/blob/master/public/data/zones.json).
+Zone data adheres to following json schema:
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "patternProperties": {
+    "^[a-zA-Z0-9-]+$": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "object",
+          "properties": {
+            "en": { "type": "string" }
+          },
+          "required": ["en"]
+        },
+        "aetherytes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "position": {
+                "type": "object",
+                "properties": {
+                  "x": { "type": "number" },
+                  "y": { "type": "number" }
+                },
+                "required": ["x", "y"]
+              },
+              "name": {
+                "type": "object",
+                "properties": {
+                  "en": { "type": "string" }
+                },
+                "required": ["en"]
+              }
+            },
+            "required": ["position", "name"]
+          }
+        }
+      },
+      "required": ["name", "aetherytes"]
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+### Nodes
+You can see the existing data [here](https://github.com/YouHaveTrouble/DiscipleOfLand/blob/master/public/data/nodes.json).
+Node data adheres to following json schema:
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "job": { 
+      "type": "string",
+      "enum": ["botanist", "miner"]
+    },
+    "type": { 
+      "type": "string",
+      "enum": ["unspoiled", "legendary"]
+    },
+    "position": {
+      "type": "object",
+      "properties": {
+        "zone": { "type": "string" },
+        "x": { "type": "number" },
+        "y": { "type": "number" }
+      },
+      "required": ["zone", "x", "y"]
+    },
+    "times": {
+      "type": "array",
+      "items": { "type": "string", "pattern": "^\\d{2}:\\d{2}-\\d{2}:\\d{2}$" },
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "items": {
+      "type": "array",
+      "items": { "type": "string" }
+    }
+  },
+  "required": ["job", "type", "position", "times", "items"]
+}
+```
+`times` is an array of two strings representing the time the node is available in Eorzea time.
+First value is the time the node becomes available, second value is the time the node disappears.
+
+`items` elements are ids corresponding to the items in the items.json file.
+

index.html

@@ -13,6 +13,11 @@
     <meta property="twitter:description" content="Track timed gathering nodes in Final Fantasy XIV.">
     <meta property="og-url" content="https://dol.yht.one">
     <meta property="twitter:url" content="https://dol.yht.one">
+    <script
+            async
+            src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8262480617556085"
+            crossorigin="anonymous"
+    ></script>
 </head>
 <body>
 <noscript>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discipleofland",
-  "version": "0.0.7",
+  "version": "0.1.2",
   "private": true,
   "type": "module",
   "scripts": {
@@ -20,7 +20,7 @@
     "@vue/eslint-config-typescript": "^12.0.0",
     "eslint": "^8.51.0",
     "eslint-plugin-vue": "^9.17.0",
-    "vite": "^5.3.3",
+    "vite": "^5.4.18",
     "vue-eslint-parser": "^9.3.2",
     "vite-plugin-eslint": "^1.8.1"
   },

public/data/items.json

@@ -134,5 +134,11 @@
     "level": 90,
     "stars": 2,
     "perception": 3600
+  },
+  "shaaloani-coffee": {
+    "name": "Shaaloani Coffee",
+    "level": 100,
+    "stars": 2,
+    "perception": 4740
   }
 }

public/data/nodes.json

@@ -249,7 +249,7 @@
     ]
   },
   {
-    "job": "botanist",
+    "job": "miner",
     "type": "unspoiled",
     "position": {
       "zone": "kozamauka",
@@ -311,5 +311,21 @@
     "items": [
       "paldao-log"
     ]
+  },
+  {
+    "job": "botanist",
+    "type": "legendary",
+    "position": {
+      "zone": "shaaloani",
+      "x": 34.9,
+      "y": 16.3
+    },
+    "times": [
+      "04:00-06:00",
+      "16:00-18:00"
+    ],
+    "items": [
+      "shaaloani-coffee"
+    ]
   }
 ]

src/App.vue

@@ -36,6 +36,7 @@
     </main>
     <footer>
       <p>v{{ version }}</p>
+      <p><a href="https://github.com/YouHaveTrouble/DiscipleOfLand/blob/master/CONTRIBUTING.MD">Need YOUR help to input node, item and zone data!</a></p>
     </footer>
   </div>
 </template>
@@ -90,7 +91,7 @@ export default defineComponent({
     this.eorzeaTime = new EorzeaTime();
     setInterval(() => {
       this.eorzeaTime = new EorzeaTime();
-    }, 500);
+    }, 1000);
 
     const itemData: Response | null = await fetch("/data/items.json")
       .catch((): null => {
@@ -227,7 +228,13 @@ nav {
 }
 footer {
   display: flex;
+  flex-direction: column;
   justify-content: center;
   align-items: center;
+  padding: 1rem 0.25rem;
+  gap: 0.5rem;
+  p {
+    margin: 0;
+  }
 }
 </style>

src/components/FiltersMenu.vue

@@ -135,8 +135,7 @@ export default defineComponent({
   watch: {
     filters: {
       handler(newFilters) {
-        const filters = new Filters(newFilters);
+        window.localStorage.setItem("filters", newFilters.serialize());
-        window.localStorage.setItem("filters", filters.serialize());
       },
       deep: true,
     },

src/components/GatheringNode.vue

@@ -2,12 +2,29 @@
   <article
     class="node"
     :class="{active: gatheringNode.isActive(eorzeaTime)}"
+  >
+    <div class="location-info">
+      <div
+        v-if="!gatheringNode.isActive(eorzeaTime)"
       >
         <div class="timer">
           {{
-        gatheringNode.isActive(eorzeaTime) ? 'Active' : prettyTimer(gatheringNode.getSecondsToNextActiveTime(eorzeaTime))
+            prettyTimer(secondsToNextActiveTime)
           }}
         </div>
+      </div>
+      <div
+        v-else
+      >
+        <div class="timer">
+          Active
+          <div class="countdown">
+            {{
+              prettyTimer(secondsToNextInactiveTime)
+            }}
+          </div>
+        </div>
+      </div>
       <div class="job">
         <div class="icon">
           <img
@@ -27,9 +44,12 @@
           >
         </span>
         <div class="info">
-        <span>{{ zones[gatheringNode.nearestAetheryte.position.zone]?.name?.en }}</span>
+          <span class="zone-name">{{ zones[gatheringNode.location.zone]?.name?.en }}</span>
-        <span>{{ gatheringNode.nearestAetheryte.name.en }}</span>
+          <span class="aetheryte-name">{{ gatheringNode.nearestAetheryte.name.en }}</span>
-        <span>{{ gatheringNode.nearestAetheryte.position.x.toFixed(1) }}, {{ gatheringNode.nearestAetheryte.position.y.toFixed(1) }}</span>
+          <span class="coords">{{
+            gatheringNode.nearestAetheryte.position.x.toFixed(1)
+          }}, {{ gatheringNode.nearestAetheryte.position.y.toFixed(1) }}</span>
+        </div>
       </div>
     </div>
     <div class="items">
@@ -51,6 +71,12 @@ import Zone from "@/entities/Zone";
 
 export default defineComponent({
   name: "GatheringNode",
+  data() {
+    return {
+      secondsToNextInactiveTime: 0 as number,
+      secondsToNextActiveTime: 0 as number,
+    };
+  },
   props: {
     gatheringNode: {
       type: Object as PropType<Node>,
@@ -65,22 +91,42 @@ export default defineComponent({
       required: true
     },
   },
+  watch: {
+    eorzeaTime: {
+      handler() {
+        this.calculateTimers()
+      }
+    }
+  },
   methods: {
     prettyTimer(seconds: number): string {
       const minutes = Math.floor(seconds / 60);
       const remainingSeconds = seconds % 60;
       return `${minutes}:${remainingSeconds < 10 ? '0' : ''}${remainingSeconds}`;
+    },
+    calculateTimers() {
+      this.secondsToNextInactiveTime = this.gatheringNode.getSecondsToNextInactiveTime(this.eorzeaTime);
+      this.secondsToNextActiveTime = this.gatheringNode.getSecondsToNextActiveTime(this.eorzeaTime);
     }
   },
+  mounted() {
+    this.calculateTimers();
+  }
 });
 </script>
 
 <style scoped lang="scss">
 
 @keyframes pulsing {
-  0% {background-color: rgba(255,255,255, 0.05);}
+  0% {
-  50% {background-color: rgba(255,255,255, 0.075);}
+    background-color: rgba(255, 255, 255, 0.05);
-  100% {background-color: rgba(255,255,255, 0.05);}
+  }
+  50% {
+    background-color: rgba(255, 255, 255, 0.075);
+  }
+  100% {
+    background-color: rgba(255, 255, 255, 0.05);
+  }
 }
 
 .node {
@@ -93,6 +139,15 @@ export default defineComponent({
   border: 1px solid #fff;
   padding: 0.5rem;
   border-radius: 0.25rem;
+  content-visibility: auto;
+
+  .location-info {
+    display: flex;
+    flex-direction: row;
+    flex-wrap: wrap;
+    gap: 1rem;
+    align-items: center;
+  }
 
   &.active {
     animation: infinite pulsing 6s;
@@ -102,6 +157,8 @@ export default defineComponent({
     min-width: 7rem;
     font-size: 2rem;
     display: flex;
+    height: 100%;
+    flex-direction: column;
     justify-content: center;
     align-items: center;
   }
@@ -125,7 +182,7 @@ export default defineComponent({
   .aetheryte {
     display: flex;
     flex-direction: row;
-    justify-content: center;
+    justify-content: flex-start;
     align-items: center;
     gap: 0.25rem;
     font-size: 1.5rem;
@@ -149,6 +206,17 @@ export default defineComponent({
       justify-content: center;
       align-items: start;
       gap: 0.1rem;
+      line-height: 1;
+
+      .zone-name {
+        font-size: 0.75rem;
+      }
+      .aetheryte-name {
+        font-size: 1.1rem;
+      }
+      .coords {
+        padding-top: 0.15rem;
+      }
     }
   }
 

src/components/SortedNodeList.vue

@@ -49,9 +49,7 @@ export default defineComponent(
         }
       },
       eorzeaTime: {
-        handler(newValue, oldValue) {
+        handler() {
-          if (oldValue === undefined) return;
-          if (newValue?.getMinutes() === oldValue?.getMinutes()) return;
           this.sortListByTime();
         }
       }
@@ -72,7 +70,7 @@ export default defineComponent(
         let filters: Filters | null = null;
         let filtersString = window.localStorage.getItem("filters");
         if (filtersString === null) {
-          window.localStorage.setItem("filters", JSON.stringify(new Filters()));
+          window.localStorage.setItem("filters", new Filters().serialize());
           filtersString = window.localStorage.getItem("filters");
         }
         if (filtersString === null) {

src/components/icons/GithubLogo.vue

@@ -1,11 +1,22 @@
 <template>
-  <div class="github-logo" aria-label="Github logo" title="GitHub">
+  <div
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
+    class="github-logo"
+    aria-label="Github logo"
+    title="GitHub"
+  >
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      viewBox="0 0 128 128"
+    >
       <g :fill="color">
-        <path fill-rule="evenodd" clip-rule="evenodd"
-              d="M64 5.103c-33.347 0-60.388 27.035-60.388 60.388 0 26.682 17.303 49.317 41.297 57.303 3.017.56 4.125-1.31 4.125-2.905 0-1.44-.056-6.197-.082-11.243-16.8 3.653-20.345-7.125-20.345-7.125-2.747-6.98-6.705-8.836-6.705-8.836-5.48-3.748.413-3.67.413-3.67 6.063.425 9.257 6.223 9.257 6.223 5.386 9.23 14.127 6.562 17.573 5.02.542-3.903 2.107-6.568 3.834-8.076-13.413-1.525-27.514-6.704-27.514-29.843 0-6.593 2.36-11.98 6.223-16.21-.628-1.52-2.695-7.662.584-15.98 0 0 5.07-1.623 16.61 6.19C53.7 35 58.867 34.327 64 34.304c5.13.023 10.3.694 15.127 2.033 11.526-7.813 16.59-6.19 16.59-6.19 3.287 8.317 1.22 14.46.593 15.98 3.872 4.23 6.215 9.617 6.215 16.21 0 23.194-14.127 28.3-27.574 29.796 2.167 1.874 4.097 5.55 4.097 11.183 0 8.08-.07 14.583-.07 16.572 0 1.607 1.088 3.49 4.148 2.897 23.98-7.994 41.263-30.622 41.263-57.294C124.388 32.14 97.35 5.104 64 5.104z"/>
         <path
-          d="M26.484 91.806c-.133.3-.605.39-1.035.185-.44-.196-.685-.605-.543-.906.13-.31.603-.395 1.04-.188.44.197.69.61.537.91zm2.446 2.729c-.287.267-.85.143-1.232-.28-.396-.42-.47-.983-.177-1.254.298-.266.844-.14 1.24.28.394.426.472.984.17 1.255zM31.312 98.012c-.37.258-.976.017-1.35-.52-.37-.538-.37-1.183.01-1.44.373-.258.97-.025 1.35.507.368.545.368 1.19-.01 1.452zm3.261 3.361c-.33.365-1.036.267-1.552-.23-.527-.487-.674-1.18-.343-1.544.336-.366 1.045-.264 1.564.23.527.486.686 1.18.333 1.543zm4.5 1.951c-.147.473-.825.688-1.51.486-.683-.207-1.13-.76-.99-1.238.14-.477.823-.7 1.512-.485.683.206 1.13.756.988 1.237zm4.943.361c.017.498-.563.91-1.28.92-.723.017-1.308-.387-1.315-.877 0-.503.568-.91 1.29-.924.717-.013 1.306.387 1.306.88zm4.598-.782c.086.485-.413.984-1.126 1.117-.7.13-1.35-.172-1.44-.653-.086-.498.422-.997 1.122-1.126.714-.123 1.354.17 1.444.663zm0 0"/>
+          fill-rule="evenodd"
+          clip-rule="evenodd"
+          d="M64 5.103c-33.347 0-60.388 27.035-60.388 60.388 0 26.682 17.303 49.317 41.297 57.303 3.017.56 4.125-1.31 4.125-2.905 0-1.44-.056-6.197-.082-11.243-16.8 3.653-20.345-7.125-20.345-7.125-2.747-6.98-6.705-8.836-6.705-8.836-5.48-3.748.413-3.67.413-3.67 6.063.425 9.257 6.223 9.257 6.223 5.386 9.23 14.127 6.562 17.573 5.02.542-3.903 2.107-6.568 3.834-8.076-13.413-1.525-27.514-6.704-27.514-29.843 0-6.593 2.36-11.98 6.223-16.21-.628-1.52-2.695-7.662.584-15.98 0 0 5.07-1.623 16.61 6.19C53.7 35 58.867 34.327 64 34.304c5.13.023 10.3.694 15.127 2.033 11.526-7.813 16.59-6.19 16.59-6.19 3.287 8.317 1.22 14.46.593 15.98 3.872 4.23 6.215 9.617 6.215 16.21 0 23.194-14.127 28.3-27.574 29.796 2.167 1.874 4.097 5.55 4.097 11.183 0 8.08-.07 14.583-.07 16.572 0 1.607 1.088 3.49 4.148 2.897 23.98-7.994 41.263-30.622 41.263-57.294C124.388 32.14 97.35 5.104 64 5.104z"
+        />
+        <path
+          d="M26.484 91.806c-.133.3-.605.39-1.035.185-.44-.196-.685-.605-.543-.906.13-.31.603-.395 1.04-.188.44.197.69.61.537.91zm2.446 2.729c-.287.267-.85.143-1.232-.28-.396-.42-.47-.983-.177-1.254.298-.266.844-.14 1.24.28.394.426.472.984.17 1.255zM31.312 98.012c-.37.258-.976.017-1.35-.52-.37-.538-.37-1.183.01-1.44.373-.258.97-.025 1.35.507.368.545.368 1.19-.01 1.452zm3.261 3.361c-.33.365-1.036.267-1.552-.23-.527-.487-.674-1.18-.343-1.544.336-.366 1.045-.264 1.564.23.527.486.686 1.18.333 1.543zm4.5 1.951c-.147.473-.825.688-1.51.486-.683-.207-1.13-.76-.99-1.238.14-.477.823-.7 1.512-.485.683.206 1.13.756.988 1.237zm4.943.361c.017.498-.563.91-1.28.92-.723.017-1.308-.387-1.315-.877 0-.503.568-.91 1.29-.924.717-.013 1.306.387 1.306.88zm4.598-.782c.086.485-.413.984-1.126 1.117-.7.13-1.35-.172-1.44-.653-.086-.498.422-.997 1.122-1.126.714-.123 1.354.17 1.444.663zm0 0"
+        />
       </g>
     </svg>
   </div>

src/entities/Node.ts

@@ -47,6 +47,15 @@ export default class Node {
     return countdown;
   }
 
+  getCountdownToInactive(eorzeaTime: EorzeaTime): number {
+    let countdown: number = Infinity;
+    for (const timeRange of this.times) {
+      const endTimeFrame: number = timeRange.getEndTimeFrame(eorzeaTime);
+      if (endTimeFrame < countdown) countdown = endTimeFrame;
+    }
+    return countdown;
+  }
+
   getNextActiveTime(eorzeaTime: EorzeaTime): EorzeaTime {
     let countdownTimeStamp: number = Infinity;
     for (const timeRange of this.times) {
@@ -56,8 +65,21 @@ export default class Node {
     return EorzeaTime.fromEorzeaTime(new Date(this.getCountdownToActive(eorzeaTime)));
   }
 
+  getNextInactiveTime(eorzeaTime: EorzeaTime): EorzeaTime {
+    let countdownTimeStamp: number = Infinity;
+    for (const timeRange of this.times) {
+        const endTimeFrame: number = timeRange.getEndTimeFrame(eorzeaTime);
+        if (endTimeFrame < countdownTimeStamp) countdownTimeStamp = endTimeFrame;
+    }
+    return EorzeaTime.fromEorzeaTime(new Date(this.getCountdownToInactive(eorzeaTime)));
+  }
+
   getSecondsToNextActiveTime(eorzeaTime: EorzeaTime): number {
     return Math.floor((this.getNextActiveTime(eorzeaTime).realDate.getTime() - eorzeaTime.realDate.getTime()) / 1000);
   }
 
+  getSecondsToNextInactiveTime(eorzeaTime: EorzeaTime): number {
+    return Math.floor((this.getNextInactiveTime(eorzeaTime).realDate.getTime() - eorzeaTime.realDate.getTime()) / 1000);
+  }
+
 }

src/entities/TimeRange.ts

@@ -13,7 +13,7 @@ export default class TimeRange {
   public isWithinTimeFrame(hour: number, minute: number): boolean {
     return (
         this.from[0] < hour || this.from[0] == hour && this.from[1] <= minute)
-        && (hour < this.to[0] || hour == this.to[0] && minute <= this.to[1]
+        && (hour < this.to[0] || hour == this.to[0] && minute < this.to[1]
       );
   }
 
@@ -29,4 +29,17 @@ export default class TimeRange {
     return targetDate.getTime();
   }
 
+    /**
+     * Returns the timestamp when the current time range will end
+     * @param eorzeaTimeFrom
+     */
+  public getEndTimeFrame(eorzeaTimeFrom: EorzeaTime): number {
+    const targetDate = new Date(eorzeaTimeFrom.eorzeaDate.getTime());
+    targetDate.setUTCHours(this.to[0], 0, 0, 0);
+    if (eorzeaTimeFrom.getHours() >= this.to[0]) {
+      targetDate.setUTCHours(this.to[0] + 24);
+    }
+    return targetDate.getTime();
+  }
+
 }

src/util/Filters.ts

@@ -18,7 +18,13 @@ export default class Filters {
     ) {
         this.minLevel = data?.minLevel || 91;
         this.maxLevel = data?.maxLevel || 100;
-        const jobData = data?.jobs || [Job.BOTANIST, Job.MINER];
+        let jobData = [
+            Job.BOTANIST.toLowerCase(),
+            Job.MINER.toLowerCase()
+        ];
+        if (data?.jobs && Array.isArray(data?.jobs) && data?.jobs?.length > 0) {
+            jobData = data.jobs;
+        }
 
         for (const job of jobData) {
             const parsedJob = jobFromString(job);
@@ -26,24 +32,33 @@ export default class Filters {
             this.jobs.add(parsedJob);
         }
 
-        const nodeTypeData = data?.nodeTypes || [
+        let nodeTypeData = [
-            NodeType.UNSPOILED,
+            NodeType.UNSPOILED.toLowerCase(),
         ];
+        if (data?.nodeTypes && Array.isArray(data?.nodeTypes) && data?.nodeTypes?.length > 0) {
+            nodeTypeData = data.nodeTypes;
+        }
 
+        if (Array.isArray(nodeTypeData)) {
             for (const nodeType of nodeTypeData) {
                 const parsedNodeType = nodeTypeFromString(nodeType);
                 if (!parsedNodeType) continue;
                 this.nodeTypes.add(parsedNodeType);
             }
+        }
+
 
     }
 
     serialize(): string {
+        const serializedJobs = Array.from(this.jobs);
+        const serializedNodeTypes = Array.from(this.nodeTypes);
+
         return JSON.stringify({
             minLevel: this.minLevel,
             maxLevel: this.maxLevel,
-            jobs: Array.from(this.jobs).map(job => job),
+            jobs: serializedJobs,
-            nodeTypes: Array.from(this.nodeTypes).map(nodeType => nodeType),
+            nodeTypes: serializedNodeTypes,
         });
     }