allianceauth-pve

PvE tool for AllianceAuth

Free software: GNU General Public License v3

Features

This package aims at helping groups of people manage PvE sessions, centralized loot management and loot taxes.

Create a rotation

Rotations are a sort of containers for entries. When created, they have some options to customize the behavior of the tool with the entries, such as tax rate, count of setups of the system before ratting etc.

They can be created by the people with the right permission (see below). For them, a button will be avaiable in the main page. It'll lead to a form for creating a rotation.

Add Entries

Entries are the corrisponding of an actual PvE fleet. They consist in an estimated total loot value and a set of shares. When an Entry is submitted to a rotation, all the rules of tax rate and setups are applied and the loot value is split between the participants according to which sites they ran and the site value. To add an entry to a rotation, click on the plus button on the bottom left of the screen.

Every entry has a list of shares. To add a share, search for the character you want to add in the panel on the right and click the add button.

A share will be added with the first role in the list, no setup, and first/last site both set to the site the fleet is currently running. The first/last site is the inclusive range of sites the character took part in (leave both empty for a share that ran no sites). Setups are helpful in wormholes when you want to track who helped setting up a system before ratting. Roles and sites define how loot will be split between the shares: every site (from 1 to the highest last site) is worth the same fraction of the entry, and each site's value is split only among the characters that ran it, weighted on their roles. For example, if someone ran sites x to y with a role with a value of 1 and someone else ran the same sites with a role with a value of 2, this last person will receive double the amount of money of the first one; a character running a site alone gets that site's whole value.

Since version v3.0.0, each site can have a different weight when splitting the loot:

• Site scaling=Flat means all sites have equal weight and the loot is split equally.
• Site scaling=Fabricator models the scaling in Rampant Drone Fabricator combat sites. This is a simple linear scaling, and you can customize the coefficient (e.g. coeff=1 => wave weights 1,2,3,4; coeff=2 => wave weights 1,3,5,7 etc.)

In order to add a role, you can click on the New Role button and create one from scratch or load a roles setup, if you chose at least one in the rotation form, by clicking on the Load Roles Setup button.

When you have a role loaded, you can choose it from the dropdown select on the shares.

On the center of the right panel there is the Estimated total section. There is a numeric field and a list of buttons if you selected at least one in the rotation form. you can either input the estimated total by hand or click on the buttons while you are running the sites.

On the right of the Estimated total field there are 4 buttons for moving the last site of the shares forward or back by one. If you hover each of them there'll be a tooltip telling what each button does. The ones that change selected chars only edit the shares with the green arrow. This is helpful if you are doing the form while you are running the sites: if a person leaves, you can click on the arrow and it'll be unselected.

Once you have submitted the entry, you'll see updating the summary and the entry list on the rotation page. You can edit an entry by clicking the arrow on the right of the row in the entry list and then click on the edit button.

NEW: From version 2.0, the entry form is saved into local storage every time you change something. This means that if you accidentally close the page while you are filling the form, your progress won't be lost. When you open the form again you'll find all the data you inputted before.

Funding Projects

In the dashboard, there is a section for funding projects. People with the appropriate permission (see below) can create projects and add them to the list. When adding entries, an active funding project can be selected with a percentage of the entry to be added to the project. The money will be added to the project total once the rotation is closed.

In each project page, there is a list of the people who have contributed to the project and the total amount of money they have contributed and the current completion percentage of the project.

Projects need to be closed manually by people with the appropriate permission and they will not appear during entry creation.

Closed Rotation

When the loot is sold, a person with the right permission (see below) can close the rotation and insert the sales value in the form. Then the closed rotation page will be shown with the right amount of money to send to each person, calculated on the sales value.

You can see all the closed rotations from the dashboard.

In a closed rotation summary, you can click on a character name and on an actual total to copy their value. Once you do so, the corresponding row in the table will be of a different color to help tracking down who is already being copied. To reset a row color, click on the X button on the right of the row.

Buttons and Roles Setups

Buttons and roles setups can be created in the admin page by people who have access.

Rotation Presets

Rotation presets can be created in the admin page by people who have access. They can be used to ensure a rotation with a certain name is always open with the specified settings.

Settings

Help wanted

This modeling is based on how whormoles fleets and loot are managed. If you have some feature requests for other types of environment, pls join AllianceAuth discord and give me a shout in the allianceauth-pve community forum channel. I don't have any experience in anything except whormholes so any help is appriciated.

Installation

This app depends on Allianceauth and requires a functioning installation. It also depends on the django-eveonline-sde package, so make sure to follow its installation instructions before installing this package.

1. pip install allianceauth-pve
2. Add allianceauth_pve (note the underscore) to your INSTALLED_APPS
3. Run migrations
4. Run collectstatic
5. Restart AllianceAuth

Updating

1. pip install -U allianceauth-pve
2. Run migrations
3. Run collectstatic
4. Restart AllianceAuth

Permissions

The following permissions are provided:

1. access_pve: only users with this permission can see the tool and be added in entries.
2. manage_entries: only users with this permissions can create entries.
3. manage_rotations: only users with this permissions can create and close rotations.
4. manage_funding_projects: only users with this permissions can create and close funding projects.

You'll have to assign this permissions to desired groups/states to make the tool work.

Management commands

The command pve_clear_cache can be used to clear the Redis cache of this app.

Credits

From an original idea of iRBlue.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.