TetraLogger

An open-source Alt1 Plugin designed for tracking Tetracompass rewards.

Report bugs or questions, message me 🙂 -> Discord: RedX1000#3655

RuneApps forum page: https://runeapps.org/forums/viewtopic.php?id=1480

• NOTE: When reporting a crash, please take a screenshot of the reward window and Tetracompass capture history send it to me. Use Windows Key + Shift + S, Lightshot, or Gyazo to take the screenshot to avoid distortion.
  
  

Table of Contents

• Description
• How to install
• Consider sending a donation!
• Instructions on how to use
  • Capture Rewards
  • AutoCapture
  • Export to CSV
  • History (Rollback)
  • Insert
  • Clear Options menu
  • Toggleable loot tabs
  • Information & Updates
  • Home button
• Settings
  • Image Searching Algorithm
  • Miscellaneous Toggles
• Additional Information
  • Things to avoid accidentally covering when scanning
  • Avoiding menus causing multi-capturing
  • Accessing localStorage
  • TetraLogger is flexy!
  • Potential or planned updates
  • Special thanks
    
    

Description

This application was created to provide players with a way to easily record their Tetracompass rewards over the course of their Tetracompass runs or during an ancient casket opening, and to allow users to share their Tetracompass rewards data with others.

TetraLogger works out of the box, so you don't have to adjust any settings if you don't want to. Manually capture or press the lock to autocapture ancient casket rewards to begin logging!

How to install

Copy and paste this link in your browser to install TetraLogger to Alt1 automatically
alt1://addapp/https://redx1000.github.io/TetraLogger/appconfig.json

Or use direct link
https://redx1000.github.io/TetraLogger

To install with the direct link

1. Copy the direct link.
2. Open Alt1 applications and open the browser.
3. Paste link in URL bar and press enter.
4. Click Add App on the top of the page.
5. Accept permissions and click confirm.
   
   

Consider sending a donation!

The Logger projects are passion project and I have future plans to use these plugins as a base for future loggers
Consider sending a small donation in this direction🙂.

Instructions on how to use

Capture Rewards

1. Open the ancient casket.
   • Make sure the Tetracompass rewards window is not covered in order to get a correct reading; list of things to not obfuscate at Additional Information and Avoiding menus causing multi-capturing.
2. Press the Capture button, press Alt+1, or enable Autocapture to record the Tetracompass reward interface.
3. Wait a bit, recording can be less than 600ms or over 5 seconds seconds depending on the amount of rewards in the window and the image searching algorithmn used (Some users experience longer times than usual. Tweak with the settings or DM me if this happens).
4. Rewards appear in the TetraLogger interface with the value, and a dynamic display that updates when new rewards come in, the total number of rewards logged, and the total and average value for the number of logged ancient caskets. Captured rewards are also saved within the history for review and deletion.
   
   

Autocapture

• Tetracompass rewards can be autocaptured by clicking on the lock (Closed == On, Open == Off).
• This is turned off by default. Click the lock to enable it.
• When opening settings or Clear Options Menu buttons, autocapture is automatically disabled.
• Be careful to not cover details in the Tetracompass reward window, specifically "Current Reward Value: X" coins, and the Tetracompass rewards. There is code in place to help avoid this for values, but it can happen if 2 values from the left are left uncovered. If this happens for items, perform a rollback.
• List of things to not hover over below at Additional Information and Avoiding menus causing multi-capturing.
• Easy way to fix a misread is to disable autocapture, rolling it backand recapturing it.
• If some items are not reading correctly when capturing, it is most likely caused by icons loading in. Check to see if lag detection settings are on in the TetraLogger settings and manually roll it back. The rewards should be automatically recaptured.
• If TetraLogger reads the incorrect items displayed on screen, roll it back and try again. If it reads incorrectly again adjust your image searching algorithm settings and try again. Feel free to reach out to my DMs on Discord for any questions on this.
• In the event of a multi-capture from not obfuscating the value, pause Autocapture, perform a rollback, and open the next ancient casket, then re-enable autocapture.
• In the rare event that the value of the next ancient casket is equivalent to the value of the previous ancient casket, disable Autocapture and manually capture the reward.
  
  

Export to CSV

• Export to CSV will create a comma separated value file of the your Tetracompass rewards and Tetracompass history from localStorage and allows the user to download the file.
• This will be useful for storing data long term or for crowdsourcing data, i.e. Recording Tetracompass drop-rates or clan ancient casket opening events.
  
  
  
  

History (Rollback)

• History will open a menu that displays every captured ancient casket reward that can be rolled back and deleted.
• By default, History will the display the last 25 items you've captured. This can be adjusted in the Settings under History Display Limit.
• Rollbacks performed in History will remove the given reward items quantities, its value, and its counter.
• When you click "Delete", verification buttons "Yes" and "No" will appear in it's place. Upon clicking yes, the given entry will be deleted from localStorage and the display will update to reflect this. If the deleted entry is the first in the list, the recently captured rewards display will clear itself. Clicking "No" will revert the button back to "Delete".
  
• These displayed Tetracompass rewards persist between sessions, so rewards can be rolled back from localStorage at any time.
• This is great if you accidentally scan a reward twice, trigger a multi-capture, or if TetraLogger incorrectly identifies an item or value (Ways to mitigate multi-capture from value obfuscation jump to Avoiding menus causing multi-capturing.)
  
  
  

Insert

• Insert allows users to directly manipulate localStorage by allowing users to add or subtract items by manually creating a new entry to be inserted into the database.
• To remove items from localStorage, make the value and quantities of items negative before inserting.
• The Fetch GE button uses the Runescape Wiki's APIs for pulling the current price of the selected items and autofills the reward value based on the item prices and quantity.
• Entries inserted into localStorage are marked in the History menu with a [C] which means "Custom".
• To insert items into localStorage:
  • Select the items you want to enter into the database.
  • Set the quantity of items you are trying to add.
  • Set the value manually or by selecting the "Fetch GE" button.
  • Click confirm and review the verification page.
  • Click confirm to add it into localStorage.
    
    

Clear Options Menu

• Clear Options Menu has multiple choices that determine the scope of how much you want to delete from the database of items.
• There are confirm windows for each option except Refresh page.

1. Reset Settings: Sets settings back to default settings. Default settings are marked with an asterisk or in hover-over text.
2. Clear all items from database: Clears the database of quantities and values of items and rewards.
3. Completely reset TetraLogger: Nuclear option, COMPLETELY resets TetraLoggers settings and database. This is a recommended last option for troubleshooting. A value within localStorage may or may not change between updates (I try not to), and if it turns out that it breaks it, give this a try, otherwise reach out to me on Discord and we'll chat about it 🙂.
4. Refresh page: Refreshes the plugin webpage, does not delete anything.
   
   

Toggleable loot tabs

• Click on the loot tab title to hide the loot, and click it again to show the loot.
• Hidden tabs will be strikethroughed, and the space below it will be hidden.
• Hovering over it will give a tooltip on whether you can hide or show the loot.
  
  

Information & Updates

• Information & Updates displays the following:
  • The latest news about the plugin.
  • TetraLogger's repository link.
  • My discord information.
  • My Ko-fi donation link.
• I recommend checking here occasionally if anything gets updated regarding TetraLogger.
  
  

Home button

• The Home button takes you to the LoggerSuite homepage.
• LoggerSuite is the all-in-one plugin homepage for the other loggers including this one.
• There's an install link on the page, feel free to add it!
  
  

Settings

• Settings allow for user choice of Algorithm for icon recognition and miscellaneous settings toggles.
• Hover over the corresponding buttons title to learn more about what it does.
  
  

Image Searching Algorithm

1. ResembleJS: Image recognition library using ResembleJS that compares entire images and returns a percentage value. It is slow, but it is very accurate.
2. Pixelmatch: Image recognition library using Pixelmatch that compares images pixel by pixel for and returns a percentage value. It is very fast, but can be less accurate than ResembleJS.
   • Pixelmatch may have an issue where some items read incorrectly as it did in OpenLogger. If this happens, try using Hybrid or ResembleJS or send me a DM on Discord if you run into other misreads with this configuration.
3. Hybrid: A mix of the two. Pixelmatch runs first then ResembleJS. Great balance of speed and accuracy. Enabled by default.
   • Hybrid precision can be adjusted using Hybrid Alg Precision setting in the settings menu, listed below.
     
     

Miscellaneous Toggles

1. Lag Detection: Determines whether lag should be detected when scanning Tetracompass rewards. When on, it will try to rescan it again. In the event that it does not capture everything due to lag, perform a rollback and try again.
2. Multi button prevention: Prevents the user from accidentally multi-logging rewards by disabling the capture button when autocapture is on and when the plugin is trying to capture rewards.
3. No Menu Highlighter: Displays a box where the user should prevent menus appearing at all costs while AutoCapture is on. A menu appearing in this area could potentially cause a double capture, but it is rollback-able. More information on how to avoid a multi-capture, click here.
4. Hybrid Alg Precision: Allows the user to adjust the precision of the Hybrid image recognition algorithm.
   • The lower the value, the higher the precision. The higher the precision, the faster it runs, but the less accurate it could potentially be, and vice versa.
   • Default value is 0.7, minimum value is 0.1, maximum value is 1.0. Setting this value higher or lower than this will be auto-capped.
5. History Display Limit: Limits the number of latest Tetracompass rewards displayed within the History menu. Default value is 25, minimum value is 0.
   
   

Additional information

• When scanning rewards, do not cover these spots on a reward screen.

  • EOC rewards display:
    
  • Legacy rewards display:
    
  • EOC Tetracompass Casket in the corner:  
  • Legacy Tetracompass Casket on the top of the screen:  
  • Top left corner of EOC loot window:  
  • Bottom left corner of EOC loot window:  
  • Exit button of EOC loot window:  
  • Top left corner of Legacy loot window:  
  • Bottom left corner of Legacy loot window:  
  • Exit button of Legacy loot window:  
  • EOC Current Reward Value INCLUDING NUMBERS:  
  • Legacy Current Reward Value INCLUDING NUMBERS:  
  • Everything else is free game to cover. More details below about preventing multi-capturing over the value
    
    

• Avoiding menus causing multi-capturing: A few tips on where to avoid having menus appearing over the value

  • It IS NOT safe to have a menu pop up if covering ONLY the value itself. TetraLogger WILL capture if you cover up the value such that ONLY the value is covered up like this (I know this is a clue reward screenie, but rule still applies 🤫):
    

  • It IS safe to hover over or right click items as long as the menu resulting from it can cover the "Current Reward Value" text, but try to avoid it. A few examples of safe menus:
    
    

  • In the event that a capture is auto-triggered due to this, roll it back in the History menu
    
    

• This plugin stores data using localStorage within Alt1, therefore it can remember all of the loot you have gotten between sessions unless it is cleared. To access it:

  1. Right click the plugin anywhere
     
  2. Click "Inspect element"
     
  3. Click the "Application" tab
     
  4. On the left-hand side, under "Storage", click "Local Storage"
     
  5. Click the link under "Local Storage"
     
     • To Clear localStorage completely it can be done in one of two ways:
       
       1. Select "Completely Reset TetraLogger" in the Clear Options Menu and select "Reset Everything" (Easiest best choice).
          
       2. Within localStorage, filter by "TetraLogger" and remove every entry that starts with "TetraLogger".
          
          

• TetraLogger can be stretched out widthwise to display more of the loot in its display, as the top is flexy, and if you compress the bottom, you can have a minimal box for only seeing scanned items:

  
  
  
  
  

Potential or planned updates

• None here! Maybe there are a few on the OpenLogger project...

Special thanks

• Skillbert, for creating Alt1 and providing the tools and libraries to create third-party applications.
• Dala/Daladen, for providing me with an insight and reference into how the Summit Clue Logger worked to help write the original OpenLogger project and general web dev help.
• Athabastyx, for the technical help and Javascript insight. OpenLogger was my first JS/TS project and Atha helped a lot with helping me understand new functions, libraries, and how to optimize things better.
• All the people I've reached out to and have provided help regarding JS/TS and Alt1 plugin questions through the Runeapps Discord channel and DMs.
• Everyone reaching out to report bugs and make suggestions.