KDC Gasmask Breathplay Plugin

1.2.0 ยท 12 Jul 2024

Configuration Notecard Explained in Detail

The configuration notecard is used to configure the plugin.

It should be placed inside the inventory of the gasmask.

General Information

This section contains basic Information about the notecard. As well as a few short explanations about the formating of the notecard.

Probably the most important thing to remember is that lines starting with "#" are comments and will not be read by the plugin. 

# This is a configuration file for SPIRE - KDC Gasmask breathplay plugin.
# It is used to configure all aspects of the plugin.
# Empty lines as well as lines starting with "#" are ignored.
#
# This contains lines following this schema.
# <SETTING>=<VALUE>
#
# Make sure to not change the spelling of the <SETTING> part.
# (This includes changing capitalization or whitespace before or after)
# Do not change the type of the <VALUE> part.
# Do not change a number into a string in particular, as it can break
# the attachment.
# It is save to "comment out" a setting. (Place a "#" in front of the line)
# Due to technical limitations only 255 characters can be read from a
# given line, but loading configuration files with many lines takes longer.

Breath Regeneration

This section deals with regenerating breath while standing still.

AIR_REGENERATION_CONSTANT & AIR_REGENERATION_LINEAR

Air regeneration follows a linear equation, meaning that there is a base amount of air that is being regenerated every second and a bonus for standing still for longer periods of time.

Example:
AIR_REGENERATION_CONSTANT = 1.0
AIR_REGENERATION_LINEAR = 0.2

With settings like this, you would start regenerating 1.0 air every second.
In addition to that your regeneration rate will go up by 0.2 for every second you are standing still.
Seconds Regeneration Rate Total Air Regenerated
1 1.0 1.0
2 1.1 2.0
3 1.2 3.1
4 1.3 4.3
5 1.4 5.6
6 1.5 7.0
7 1.6 8.6
8 1.7 10.2
9 1.8 11.9
10 1.9 13.7
11 2.0 15.6
12 2.0 17.6

ACTION_COOLDOWN

Everything that costs air is considered to ba an action.
The action cooldown describes how much time must pass after an action, for the recovery of air to begin.

RECOVERY_END

If you ever run out of air completely, you are unable to move until you have recovered at least a minimum amount of breath.

Breath Consuming Actions

Everything that costs air is considered to ba an action.

MAX_DISTANCE & TP_CONSTANT

Teleporting is considered an action.
There are two values that can be configured about teleporting: MAX_DISTANCE and TP_CONSTANT

MAX_DISTANCE describes the maximum distance you can move within one second until it's considered a teleport.

TP_CONSTANT describes the amount of breath consumed while teleporting. This is a flat value, the actual distance traveled is not taken into account.

SIT_CONSTANT

Sitting on things can be considered an action. Example:
SIT_CONSTANT = 1.0

When you sit down you will consume 1.0 breath every second.

FLY_CONSTANT, FLY_LINEAR, FLY_QUADRATIC

Flying is considered an action.
Hovering in the air without actual movement does not consume air. The equation for flying is a bit more complex than for sitting.
The quadratic equation is based on the distance traveled within one second.

Example:
FLY_CONSTANT = 1.0
FLY_LINEAR = 0.3
FLY_QUADRATIC = 0.2

Seconds Consumption Rate Total Air Consumed
1 1.0 (= 1.0 + 0 * 0.3 + 0*0 * 0.2) 1.0
2 1.5 (= 1.0 + 1 * 0.3 + 1*1 * 0.2) 2.0
3 2.4 (= 1.0 + 2 * 0.3 + 2*2 * 0.2) 3.5
4 3.7 (= 1.0 + 3 * 0.3 + 3*3 * 0.2) 5.9
5 5.4 (= 1.0 + 4 * 0.3 + 4*4 * 0.2) 9.6
6 7.5 (= 1.0 + 5 * 0.3 + 5*5 * 0.2) 15.0

MOVE_CONSTANT, MOVE_LINEAR, MOVE_QUADRATIC

Walking and running is considered an action.
The equation for walking is the same as the one for flying.

TALK_CONSTANT, TALK_LINEAR, TALK_QUADRATIC

Talking is considered an action.
The equation for walking is the same as the one for flying, except the number of characters as the deciding factor.

TALK_CAPITAL_COST

Writing capitals can be penalized by adding a multiplyer to the equation. TALK_CAPITAL_COST = 1 => Don't penalize writing capitals.
TALK_CAPITAL_COST = 2 => Each Capital counts for 2 characters.

Filter

How should wearing a filter affect your air consumption and recovery?

The two values FILTER_MULTIPLYER_POSITIVE and FILTER_MULTIPLYER_NEGATIVE act as multipliers to the air generation and air consumption.

Example:
FILTER_MULTIPLYER_POSITIVE = 0.8
FILTER_MULTIPLYER_NEGATIVE = 2.0

Each time you would recover air, that number would be multiplied by 0.8 and each time you would consume air, that number would be multiplied by 2.0.

So if you gain 2 air in a given second without wearing a filter, you would gain 1.6 air instead.

And if you would lose 2 air in a given second without wearing a filter, you would lose 4.0 air instead.

Blur

The gasmask has a number of different blur effects to choose from, depending on the viewer you are using and the effect you want to experience.

BLUR_MODE

BLUR_LIMIT

The amount of air left before the blur effect starts to be applied.

Animations

!!!! TODO: WRITE SOME DOCUMENTATION FOR THE UPCOMMING ANIMATION FEATURE !!!!

Restrictions

As you lose are, you will be restriced more and more.
When you hit 0 air, you will go into restoration mode, where you aren't able to move anymore, and you will pass out for a while until you recover enough air to get up a again. (defined with the RECOVERY_END setting)

These limit settings determine at what point you will experience a certain restriction.
You can optionally place a "!" after the number to make the restriction last until you recover enough air to get up again after you pass out.

Example:
RECOVERY_END = 60
LIMIT_LOCATION = 20
LIMIT_NAMES = 40!

If you now drop below the threshold of 40 air, you will no longer be able to see peoples names.
If you continue to loose air, you will eventually drop below 20 and can no longer see the current location.
After you pass out, your air will slowly be restored until you recover enough air to get up again.
During that time you will regain the ability to see the current location at 20% air, but you will only get the names of the people surounding you back after recovery is fully done at 60% air.

All Restrictions

You can only use the following restrictions: