Getting Started

Installation

1. Install the Script: After purchase, you'll receive a custom URL for Torn PDA or userscript managers (Tampermonkey/Greasemonkey/etc)
2. Navigate to War Report: Go to any of your faction's ranked war reports
3. Configure Settings: Click the "RW Pay ⚙️" button in the top navigation

Initial Setup

API Configuration

The first time you use WarPay Calculator, you'll need to configure your API settings:

• API Key: Your Torn API key (found in Torn settings → API Key) should have faction api access.
  • This is available by default for Leaders and Co-Leaders.
  • If you are not a Leader or Co-Leader, you can be granted a faction role that grants you api access.
• Faction ID: Your faction's ID number (visible in your faction URL)
• For example, https://www.torn.com/factions.php?step=profile&ID=10818.
• Total Winnings: The total amount to be used for payouts.

What to Include When Reporting Issues

To help me fix problems faster, please include:

• Browser & Userscript Manager: Which browser and extension (Firefox/Tampermonkey) or App (Torn PDA) you are using
• Error Message: Some errors will be displayed in a popup modal, if so, please include the error message in your report.
• Console Logs: If you are comfortable or familiar with the console, please include the console logs in your report.
• War Report URL: The URL of the war report you were using when the error occurred.
• Payout Settings: The current payout settings can be exported and imported. If possible, please include the exported settings in your report.
• Optional: Creating a temporary API key so that I may test the exact report will drastically speed up the process of troubleshooting and fixing the issue.
• I promise to never disclose your API key to anyone, and will only use it to test the script and the exact report you are experiencing the issue with.

Feature Requests

Depending on the request, its complexity, and the time it will take to implement. Additional fees may apply. Reach out to me with your request and we can discuss the details.

Known Limitations

• API Rate Limits: Torn's API has rate limits. The script handles this automatically, but very large wars may take time
• Browser Compatibility: Designed for modern browsers (Chrome, Firefox, Edge). Some mobile browsers may have issues.

Best Practices

Before Running Calculations

• Ensure you have the correct total winnings amount
• Double check your payout method settings
• Make sure you select any applicable chains for outside hits and assists
• Fetch Armory Costs if you wish to include them in your calculations
• Enter Merc and Revive Costs if you wish to include them in your calculations
• You must click "Save Settings" after initial data fetch and settings choices or making any changes to your settings

Before Processing Payments

• Review the payout table carefully
• Verify total calculated matches expected amount
• Confirm your settings are displayed correctly in the Header section just above the payout table

Regular Maintenance

• The script will trigger the update notification when a new version is available
• Export just your payout settings as backup in case of the need to clear browser cache to import into a new browser or device
• This will include your API key, so be sure to keep it safe and secure.
• Export Complete War Data for archival purposes or to provide to me for troubleshooting and debugging purposes
• This will include all the data from the war report, including the attack data, the payout data, and the settings used to calculate the payouts.
• This will not include your API key, as that is sensitive information and should not be shared.

Recent Updates

Version 3.7.11

• Fixed bug where respect loss values in the API response were affecting the accuracy of term limits application

Version 3.7.10 🚀

• Implemented custom script server (scriptserver.tornjunkie.com) with tokenized URLs for each customer
• Automatic updates to download and update URLs in userscript headers for unique customer URLs
• Restored automatic update push capability, enabling streamlined feature releases and bug fixes with automatic update notifications in Torn PDA and userscript managers

Version 3.7.7

• Fixed bug in settings parsing that was causing payout percentage settings to reset to default values
• Refactored code to utilize consistent validation logic across multiple settings, improving code maintainability and clarity

Version 3.7.6

• Improved loading indicators for fetching ranked war data and faction members, enhancing user experience
• Integrated faction member data into ranked war data for better data management

Version 3.7.2

• Enhanced payout data management for better performance
• Added player search functionality in payment modal
• Improved async/await handling for smoother operation
• Introduced leader and co-leader percentage settings (Percentage method)
• Added static payment rates for outside hits and assists (Percentage method)
• Enhanced payout table to display outside hits and assists
• Updated calculation logic to include static payments and leadership cuts