warlof / eveseat-mining-ledger
An extension for Eve SeAT which is providing Mining Ledger over ESI for 2.x version
Installs: 117
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Type:seat-plugin
Requires
- eveseat/eseye: 0.*
- eveseat/web: ^2.0
README
An extension for Eve SeAT which is providing Mining Ledger over ESI for 2.x version
Setup
Create application
-
go to the following url in order to create credentials -- for live server : https://developers.eveonline.com -- for test server : https://developers.testeveonline.com
-
check
Authentication & API Access
inConnection Type
-
search for
esi-industry.read_character_mining.v1
scope inAvailable Scopes List
and move it toRequested Scopes List
by clicking on the two arrows button. -
set the following value into callback URL
{seat-public-url}/auth/mining-ledger/callback
NOTE
for example, if you have SeAT available on
seat.example.com
, the callback will behttps://seat.example.com/auth/mining-ledger/callback
but, if you're accessing to SeAT withexample.com/seat
, therefore, the callback will behttps://example.com/seat/auth/mining-ledger/callback
IMPORTANT
Application are not cross compatible. If you want to use
singularity
as server source, you have to create an application ontesteveonline.com
. You'll need to create another application oneveonline.com
in order to make call totranquility
Install package
- download package using
composer require warlof/eveseat-mining-ledger
- add package into project by appending
Warlof\Seat\MiningLedger\MiningLedgerProvider::class,
inproviders
array from/config/app.php
- publish package files using
php artisan vendor:publish --force
- run migration scripts with
php artisan migrate
- append following attributes into
.env
file
Variable | Description |
---|---|
WEML_EVE_CLIENT_ID | A valid CCP client_id |
WEML_EVE_CLIENT_SECRET | The client associated secret |
WEML_SSO_BASE | https://login.eveonline.com/oauth for live |
https://sisi.testeveonline.com/oauth for test |
|
WEML_ESI_SERVER | tranquility for live ~ singularity for test |
- finally, don't forget to restart supervisor by calling
sudo service supervisor restart
About
This package is providing ESI support for mining ledger only to SeAT 2.x which is still using the deprecated xAPI. Prefer to install SeAT 3.x if it's available since provided informations will be available in core.
Commands
This package will add few commands into your SeAT installation. You'll find their name and purpose into the table bellow.
Command name | Description | Scheduled |
---|---|---|
esi:market-prices:update | This command will update item average and adjuster prices | twice a day |
esi:mining-ledger:update | This command will update mining ledger from every character which have access granted to the package | every 10 minutes |
Permissions
This package will add two new permission for respectively character and corporation :
- corporation.warlof_mining
- character.warlof_mining
They will grant access to mining ledger on each entity type.
Usage
Every user must go on each of their character in order to active the synchronization. On character views, a new item menu should appeared called Mining
.
If user clic on this menu item and the current character has not already been binded, there will be an Activate
link on table header, on the right corner.
As CEO or officer, you'll be able to see mined amount on corporation sheet where a new item menu should appeared, called Mining
.
The first sub view Ledger
will show you a list of average mined quantity, volume and amount foreach character per year and month.
The second sub view called Tracking
will show you the list of all character and display the status if or not the character is coupled to ESI.