Skip to content

Commit

Permalink
Docs - Adding KAM Wiki Documentation (#564)
Browse files Browse the repository at this point in the history
**When merged this pull request will:**
Add the .md files from the existing
[KAM-Wiki](https://github.com/yesthatRiVin/KAM-wiki) to the docs folder
within KAT. This will allow others to continue working on the KAT Wiki
more easily as the documents will be stored in a singular place.

- _Describe what this pull request will do_
See above. This PR lays the groundwork for my master project: creating a
wiki-style guide to KAT.

#### _Each change in a separate line_
Cardiac Arrest
- Added a page on cardiac arrest
- Added a page on Shockable & Non-shockable rhythms

Hemorrhaging
- Added a page on blood loss
- Added a page on iv-fluids

Pharmacy:
- Partially completed a page on IM-medication
- Partially completed a page on IV medication
- Partially completed a page on oral-medication

Equipment
- Added a page on IV/IOs
- Added a page on AEDs
- Added a page on Accuvacs
- Added a page on Chest Seals
- Added a page on Guedel Tubes
- Added a page on King LT

### IMPORTANT

- [Development Guidelines](https://ace3.acemod.org/wiki/development/)
are read, understood and applied.
- Title of this PR uses our standard template `Component -
Add|Fix|Improve|Change|Make|Remove {changes}`.
  • Loading branch information
yesthatRiVin authored Dec 4, 2024
1 parent 505d4d6 commit 20aef94
Show file tree
Hide file tree
Showing 19 changed files with 641 additions and 101 deletions.
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.obsidian
/\!templates
/\!hidden
34 changes: 34 additions & 0 deletions docs/Cardiac/Cardiac-Arrest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Cardiac Arrest

Cardiac arrest occurs when someone reaches one of the below critical values in either their HR or their BP. This will cause the player to fall unconscious, stopping their breathing and heart rate.

**Critical Values:**
- < 20 or > 220 BPM
- > 285 / 190 mmHg
- < 50 / 40 mmHg (If HR is < 40 BPM)
- Between 20 - 30 BPM (random chance)

## Heart Rhythms

![four-rhythms](https://private-user-images.githubusercontent.com/15182031/253309068-b8e88392-2b1e-4a9d-a454-45f1a09c9940.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTY1OTQ4ODcsIm5iZiI6MTcxNjU5NDU4NywicGF0aCI6Ii8xNTE4MjAzMS8yNTMzMDkwNjgtYjhlODgzOTItMmIxZS00YTlkLWE0NTQtNDVmMWEwOWM5OTQwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA1MjQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNTI0VDIzNDk0N1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTIxZGY2YzUwNmU5ZGFhOGYyMjQ1MmMwMjYyZjE5MDYwMWU4MDZiOWNlMzYwYWYyOTVhMmMyMDVkOTc4MTQ5NjgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.-loI59Zwjzs0SgPPD1QNU-ty9aKQ5cvu3KNZpvYKNNg)
*Graph showing the five different heart rhythms and how the game switches between them*

There are five types of heart rhythms, four of which cause cardiac arrest. They typically fall into two categories: [Shockable Rhythms](/Cardiac/Shockable-Rhythms.md) & [Non-Shockable Rhythms](/Cardiac/Non-Shockable-Rhythms.md).

### Diagnosing Heart Rhythm

The most important step to maximize the probability of patient recovery is properly diagnosing the type of cardiac arrest in order to begin the proper course of treatment. The best way to do that is to use the EKG feature on the [AED-X](/Equipment/AED-X.md). Once you do that, you will see one of the below EKG values:

| Description | Value |
| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Ventricular Tachycardia (VT)](/Cardiac/Shockable-Rhythms.md#ventricular-tachycardia) | ![vTac](https://lh7-us.googleusercontent.com/Q8XcJzafKjUx1Xii46O3gNAiVlYcQcPXiG4L9FIzjUNyTD7KlM87XlDWGEHhRHmcvdxNjwDTpF9smKbt0V--8tv6E_hsgy16UkqUpfnEtTcv7VQfxtz4O-Y5M-WmBmu7UN4x1i2SR8tk_VoAT4jvVfc) |
| [Ventricular Fibrillation (VF)](/Cardiac/Shockable-Rhythms.md#ventricular-fibrillation) | ![vFib](https://lh7-us.googleusercontent.com/X2VSjZjR-3utt8pGzhumf3XJ-lLb0EShSjcMYiUV6asDBM2pMVNN868N_Xd3ryfXsZY54eh83f9sv9BuSVv14LlYRqSS6z-vrSQaFwiaUI-Th4PJgqSQVoClCpx5oTPUrMN1e3WCaA2skfFbJeybL8U) |
| [Pulseless Electrical Activity (PEA)](/Cardiac/Non-Shockable-Rhythms.md#pulseless-electrical-activity) | ![pea](https://lh7-us.googleusercontent.com/aQcmPZ5sLqjiZElM-a9_VbQavun5chOkCAHu0sVTMOT2kH0gbkis-Ivh6NEH1vKUB3BFAHkbju_R4lJyaI9peDP5E5PjAbNxmeaXQ9b02ZzwFWpMvy4TGcKa00g2pJtn9Ur6NJxt8cpE63HzzIRTDzo) |
| [Asystole](/Cardiac/Non-Shockable-Rhythms.md#asystole) | ![asystole](https://lh7-us.googleusercontent.com/LnB3GRgUu3x15snlClUudRRHaNf-gSfED1UFvY8TssQPWaUgTHhImLYItigdm_abnyPdbDQMuJDGl928O_BS48RD23tCtHdya9yQLshdYkjqU3ox9z14-x5FyRSk8h4d6M8rZ1wMHJvT3QqtjRZ_oYM) |
| CPR | ![cpr](https://lh7-us.googleusercontent.com/JQh-n7mVpPP2MogpcwXowrKtA0fdqPofUt4JPoaeLIZMH4AN-amWkGjiA1Wj8wd8AzxMMeX9H8iTxWKwjrWW4Gm5tR5VPvBg53zLT1ASwimN3M12PeILYNeamJ8hvIgzPpbe1UKrzfik5s-CgVcA8K0) |
| AED pads not connected | ![aed-error](https://lh7-us.googleusercontent.com/LxdkmO9nirIp8xo3LxBYdxrNCHG4HjO7LzPI5veoEM7sI_6LIrpSLegUJ074rhgoeIQTrDiebR6QFi86DYaxfQwuBOLz7tYbIODkqNNY1mqr6MAbR0vMv49UCzX4xam72e48C2dvvw815XvOqi8gGTE) |
>[!NOTE]
>PEA has the same EKG readout as a normal sinus rhythm.
If you don't have an AED-X, you can also use the "Analyze Rhythm" feature on the [AED](/Equipment/AED). That will tell you if it is a shockable or non-shockable rhythm.

23 changes: 23 additions & 0 deletions docs/Cardiac/Non-Shockable-Rhythms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
>[!WARNING]
>Hey! This page is under construction! Come back later!
# Non-Shockable Rhythms

A non-shockable sinus rhythms is when the cause of cardiac arrest isn't related to the electrical activity of the heart, but as a result of another cause (in KAM, it is typically blood loss). This is the most dangerous type of cardiac arrest as the treatment is potentially more time-consuming, meaning there is a greater chance of patient death. The biggest difference between non-shockable rhythms and [shockable rhythms](/Cardiac/Shockable-Rhythms.md) is that the treatment for non-shockable rhythms is the same for both types.

## Pulseless Electrical Activity

Pulseless Electrical Activity (PEA) is defined as the absence of a pulse in a patient with an otherwise normal cardiac rhythm. This means that an EKG will show them as having a pulse, but there will be no actual heartrate.

## Asystole

Asystole is defined as the total or near total absence of electrical activity within the heart. This is the worst possible form of cardiac arrest. You can diagnose an asystole rhythm by seeing a flat or nearly flat line on an EKG reading.

## Treating Non-Shockable Rhythms

>[!NOTE]
> These instructions only cover treating the cardiac arrest, they assume you have stopped any major bleeding, have secured the airways, and have an IV and are administering fluid. They also assume you have attached either the AED or AED-X and have confirmed which type of cardiac arrest you are dealing with.
1. Administer CPR for 45 seconds
2. Check for pulse & analyze rhythm
-
52 changes: 52 additions & 0 deletions docs/Cardiac/Shockable-Rhythms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Shockable Rhythms

Shockable Rhythms are rhythms that can be treated using the defrbilation features on the [AED](/Equipment/AED-X.md) or [AED-X](/Equipment/AED-X.md). You can diagnose a shockable rhythmn through either the "Analyze Rhythm" feature on the AED, or by using the EKG feature on the AED-X. Within the mod, there are two types of shockable rhythms.

## Ventricular Tachycardia

Ventricular Tachycardia (VT or V-Tac) is caused when the heart beats too fast to effectively pump blood. This can deteriorate rapidly into either VF or [PEA](/Cardiac/Non-Shockable-Rhythms.md#pulseless-electrical-activity) if left untreated, depending on settings. You can diagnose it by a rapid and uneven pattern on an EKG.

![vTac](https://lh7-us.googleusercontent.com/Q8XcJzafKjUx1Xii46O3gNAiVlYcQcPXiG4L9FIzjUNyTD7KlM87XlDWGEHhRHmcvdxNjwDTpF9smKbt0V--8tv6E_hsgy16UkqUpfnEtTcv7VQfxtz4O-Y5M-WmBmu7UN4x1i2SR8tk_VoAT4jvVfc)

## Ventricular Fibrillation

Ventricular Fibrillation (VF or V-Fib) is caused when the heart starts to beat erractically due to chaotic electrical activity. It will eventually progress to PEA if left untreated. You can diagnose it by its chaotic pattern on an EKG.

![vFib](https://lh7-us.googleusercontent.com/X2VSjZjR-3utt8pGzhumf3XJ-lLb0EShSjcMYiUV6asDBM2pMVNN868N_Xd3ryfXsZY54eh83f9sv9BuSVv14LlYRqSS6z-vrSQaFwiaUI-Th4PJgqSQVoClCpx5oTPUrMN1e3WCaA2skfFbJeybL8U)

## Treating Shockable Rhythms

The way to treat a shockable rhythm depends on the type of cardiac arrest. It's why equipment like the AED-X is so important, as the EKG feature allows you to rapidly diagnose the type of cardiac arrest and administer the proper treatment. If you only have an AED, treat all shockable rhythms as V-Tac.

>[!NOTE]
> These instructions only cover treating the cardiac arrest, they assume you have stopped any major bleeding, have secured the airways, and have an IV and are administering fluid. They also assume you have attached either the AED or AED-X and have confirmed which type of cardiac arrest you are dealing with.
### Treating V-Tac

1. Administer a shock using either the AED or AED-X
1. Analyze rhythm & check for pulse
- "Shock Advised": Continue to next step
- "No Shock Advised" & No pulse: Begin treatment for [non shockable rhythms](/Cardiac/Non-Shockable-Rhythms.md#treating-non-shockable-rhythms)
- "No Shock Advised" & Pulse: Cease treatment for Cardiac Arrest
- If using an AED-X, instead check the EKG to make sure it is still V-Tac
1. Inject [epinephrine](/Pharmacy/IM-Medication.md#epinephrine) and administer another shock
1. Analyze rhythm & check for pulse
1. Inject [amiodarone](/Pharmacy/IV-Medication.md#amiodarone) and administer another shock
1. Analyze rhythm & check for pulse
1. Inject [lidocaine](/Pharmacy/IV-Medication.md#lidocaine) and administer another shock
1. Analyze rhythm & check for pulse
1. If still in V-Tac, administer epinephrine every 2 minutes and continue shocking until change in status or ROSC

### Treating V-Fib

1. Administer a shock using either the AED or AED-X
2. Analyze rhythm & check for pulse
- "Shock Advised": Continue to next step
- "No Shock Advised" & No pulse: Begin treatment for [non shockable rhythms](/Cardiac/Non-Shockable-Rhythms.md#treating-non-shockable-rhythms)
- "No Shock Advised" & Pulse: Cease treatment for Cardiac Arrest
- If using an AED-X, instead check the EKG to make sure it is still V-Fib
3. Inject [epinephrine](/Pharmacy/IM-Medication.md#epinephrine) and administer another shock
4. Analyze rhythm & check for pulse
5. Inject [amiodarone](/Pharmacy/IV-Medication.md#amiodarone) and administer another shock
6. Analyze rhythm & check for pulse
7. If still in V-Fib, administer epinephrine every 2 minutes and continue shocking until change in status or ROSC.
22 changes: 22 additions & 0 deletions docs/Equipment/16g IV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 16g IV
![16g-iv](https://user-images.githubusercontent.com/55753928/174278114-26827cd1-6502-4e86-8c39-cb89cd78e02a.png)
Item Name: `kat_IV_16`
Mass: 0.5
Item Description: "Intravenous Needle"

---

## Description

An IV needle used to push fluids and IV medications into a patient. Can only be used on limbs that don't have tourniquets or severe damage. If there are no usable limbs, then you will have to use a [FAST IO](/Equipment/FAST%20IO.md).

## How to use

Any Limb > Advanced Treatment > "Establish 16g IV"

---

## References
- [IV Fluids](/Hemorrhaging/IV-Fluids.md)
- [IV Medication](/Pharmacy/IV-Medication.md)
- [FAST IO](/Equipment/FAST%20IO.md)
29 changes: 29 additions & 0 deletions docs/Equipment/AED-X.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
>[!WARNING]
>Hey! This page is under construction! Come back later!
# AED-X

![AED-X](https://user-images.githubusercontent.com/55753928/170477256-dfc9a3ee-751a-4267-91ed-742110abc430.png)
Item Name: `kat_X_AED`
Mass: 40
Item Description: "Used to monitor vitals and resuscitate patients"

---

## Description

A better version of the AED. It can be used to monitor HR, SpO2, and BP. It will also play an auditory beeping sound (which is togglable through ace interaction) that tells HR.

## How to Use

### Attaching to patient

Lorem Ipsum

### Administering Shock

Lorem Ipsum

---

## References
-
29 changes: 29 additions & 0 deletions docs/Equipment/AED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
>[!WARNING]
>Hey! This page is under construction! Come back later!
# AED

![AED](https://user-images.githubusercontent.com/55753928/170477092-a766bd72-b5c2-495c-856c-586cec030cad.png)
Item Name: `kat_AED`
Mass: 30
Item Description: "Used to resuscitate patients"

---

## Description

The AED is used to treat shockable cardiac arrests. In certain situations, it is much more effective to treat cardiac arrest that CPR, especially when combined with drugs such as adenosine and lidocaine.
## How to Use

- Ensure nobody touches the patient (no CPR/ BVM is performed)
- Click on chest
- Attach AED pads in the Advanced Treatment section
- Analyze rhythm in the Examine Patient section:
- “Shock Advised”: The AED will charge automatically and give a sound notification when ready. It is then possible to perform a shock (Using Epinephrine/Amiodarone/Lidocaine beforehand is advised. One medication per shock). The AED will disarm itself after some time automatically if no shock is administered.
- “No Shock Advised”:  perform CPR, administer epinephrine (not essential) and check pulse every 2 minutes
- Analyze rhythm after the shock/2 minutes of CPR

---

## References
- [Cardiac Arrest](/Cardiac/Cardiac-Arrest.md)
23 changes: 23 additions & 0 deletions docs/Equipment/Accuvac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Accuvac

![accuvac](https://user-images.githubusercontent.com/55753928/170451476-a9a10597-f29d-410a-872a-6b2139ec4e52.PNG)
Item Name: `kat_accuvac`
Mass: 7
Item Description: "ACCUVAC is a medical suction device for airway suction with battery drive for mobile use in emergency medicine."

---

## Description

Multi-use item that clears patient airway occlusions. When used, it will clear occlusions with a 100% chance.

## How to Use

The patient must be unconscious in order to use this.

Head > Airway Management > "Use Accuvac"

---

## References
-
23 changes: 23 additions & 0 deletions docs/Equipment/Chest Seal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
>[!WARNING]
>Hey! This page is under construction! Come back later!
# Chest Seal

Item Name: `kat_chestseal`
Mass: 0.2
Item Description: "Chest Seal is engineered to treat, seal, and reseal open chest wounds under most circumstances."

---

## Description

One-time use item used to treat pneumothorax, tension pneumothorax, and hemopneumothorax in patients

## How to Use

Torso > Airway Management > "Use Chest Seal"

---

## References
-
22 changes: 22 additions & 0 deletions docs/Equipment/FAST IO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# FAST IO

![fast-io](https://user-images.githubusercontent.com/55753928/174277769-c716c8a6-4cca-4956-85a2-134a8ca30622.png)
Item Name: `kat_IO_FAST`
Mass: 0.5
Item Description: "Intraosseous Needle"

---

## Description

Intraosseous needle. Able to be used on the torso in any condition, but causes severe pain upon use.

## How to Use

Torso > Advanced Treatment > "Establish FAST IO"

---

## References
- [IV Fluids](/Hemorrhaging/IV-Fluids.md)
- [IV Medication](/Pharmacy/IV-Medication.md)
23 changes: 23 additions & 0 deletions docs/Equipment/Guedel Tube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Guedel Tube

![guedel-tube](https://user-images.githubusercontent.com/55753928/170451341-d5e5a7b9-4ff1-450f-89d2-e3d2c3dcf668.png)
Item Name: `kat_guedel`
Mass: 0.5
Item Description: "The Guedel Tube is used to maintain the airway"

---

## Description

A thin tube used to support a patient's airways. It clears airway obstructions but not occlusions. It is one time use, and will automatically be removed if the patient wakes up.

## How to Use

The patient must be unconscious and their airway must not have any occlusion.

Head > Airway Management > "Use Guedel Tube"

---

## References
-
23 changes: 23 additions & 0 deletions docs/Equipment/King LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# King LT

![kingLT](https://user-images.githubusercontent.com/55753928/170451433-369bb626-ba0d-40bf-b768-72139f4201e9.PNG)
Item Name: `kat_larynx`
Mass: 0.5
Item Description: "The King LT is used to maintain the airway"

---

## Description

A one-time use item that clears airway obstructions and prevents occlusions.

## How to Use

In order to be used, the patient must be unconscious and their airway can't be occluded.

Head > Airway Management > "Use King LT"

---

## References
-
19 changes: 19 additions & 0 deletions docs/Hemorrhaging/Blood-Loss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Blood Loss

All wounds bleed. The rate at which a particular wound bleeds is dependent on the players heartrate and perfusion rate. Characters start with 6 liters of blood in their body. As it decreases, you can see different status effects.

| Blood Level (L) | Status Effect |
| --------------- | ---------------------------- |
| 5.9 - 5.1 | Lost Some Blood |
| 5.1 - 4.2 | Lost a Lot of Blood |
| 4.2 - 3.6 | Lost a Large Amount of Blood |
| 3.6 - 3.0 | Lost a Fatal Amount of Blood |

>[!NOTE]
>By default, if the player has less than 3L of blood in their body, they will die.
If a player loses a fatal amount of blood, they will go into [Cardiac Arrest](/Cardiac/Cardiac-Arrest.md).

## Coagulation

In KAM, wounds can close on their own if coagulation is enabled. Every 8 seconds, KAM checks the players HR and # of wounds. If a player has a HR of 20 or more at least one wound, and at least one clotting factor, a random wound will receive the "Unstable Clot" bandage and use up one clotting factor. A player starts with 10 clotting factors, though that number can be increased by administering certain [IV Fluids](/Hemorrhaging/IV-Fluids.md). You can fortify clots from "Unstable Clot" to "Packing Bandage" using [TXA](/Pharmacy/IV-Medication.md#txa).
Loading

0 comments on commit 20aef94

Please sign in to comment.