denngarr/seat-srp

A module for SeAT that tracks SRP requests

4.5.0 2023-07-30 03:37 UTC

Requires

• eveseat/eseye: ^2.0
• eveseat/eveapi: ^4.0
• eveseat/services: ^4.1
• eveseat/web: ^4.0

GPL-2.0

• Denngarr B'tarn
• Crypta Electrica

README

A module for SeAT that tracks SRP requests

This plugin write for SeAT is providing to your instance a way to manage your ship replacement program (SRP)

If you have issues with this, you can contact me on Eve as Crypta Electrica, or on email as '[e-mail]'

Quick Installation:

In your seat directory (By default: /var/www/seat), type the following:

php artisan down
composer require denngarr/seat-srp

(You can skip this step if you are running 3.x) After a successful installation, you can include the actual plugin by editing config/app.php and adding the following after:

        /*
         * Package Service Providers...
         */

add

        Denngarr\Seat\SeatSrp\SrpServiceProvider::class

and save the file. Now you're ready to tell SeAT how to use the plugin:

php artisan vendor:publish --force
php artisan migrate

php artisan up

And now, when you log into SeAT, you should see a 'Ship Replacement Program' link on the left.

SRP Payout Calculations

Simple SRP

By default, the application is configured in simple mode. In this mode, the SRP payout is calculated by using the evepraisal value returned from Jita sell for the whole killmail.

Advanced SRP

Advanced SRP can be enabled in the settings menu. Once enabled, the SRP Admin will need to specify rules around payout calculations. The rule types available are Type, Group and Default. The rules are matched in that order with the first match being used to calculate payout value.

Shared Configuration Options

• Price Source - Where the pricing of individual elements will be drawn from
• Base Value - A fixed ISK amount added to each payout from this rule
• Hull % - The percentage of the ship hull value to be paid out.
• Fit % - The percentage of the ship fit value to be paid out.
• Cargo % - The percentage of the ship cargo value to be paid out.
• Deduct Insurance - If selected, the payout will be reduced by the benefit gained from insurance (payout - cost)

Rule Types

Type Rules

Type rules match the ship type exactly, for example a Scorpion or Blackbird. Note that variants are considered separate ships. Ie a Raven is different to a Raven Navy Issue.

Group Rules

Group rules match based on the group of the ship, such as Frigate, Shuttle or Battleship.

Default Rule

The default rule is the rule used when there are no type or group rules that have been triggered. The default rule is a catch all for any remaining payout calculations.

Discord Webhook (optional)

Automated notifications of new SRP Requests submitted in Discord

In Discord application:

1. On a channel of your choice, click the cog icon to open the channel settings
2. In the channel settings, navigate to the Webhooks tab
3. Click Create Webhook
4. Fill in name for the webhook and (optional) image
5. Copy the Webhook URL
6. Click Save to finish creating the webhook

In SeAT file:

The Ship Replacement Program Settings page accepts two variables for the webhook:

1. (required) Webhook URL: this is the url you copied when creating the webhook in Discord
2. (optional) Discord Mention Role: this can be a room mention (e.g. @here), a Discord role ID, or a specific user ID - Role ID and User ID can be obtained by typing /@rolename into a channel (e.g. /@srp_manager)

Example of entries:

Webhook URL = https://discordapp.com/api/webhooks/513619798362554369/Px9VQwiE5lhhBqOjW7rFBuLmLzMimwcklC2kIDJhQ9hLcDzCRPCkbI0LgWq6YwIbFtuk
Discord Mention Role = <@&198725153385873409>

Good luck, and Happy Hunting!! o7

Usage Tracking

In order to get an idea of the usage of this plugin, a very simplistic form of anonymous usage tracking has been implemented.

Read more about the system in use here