# FCP - Tools

![release](https://img.shields.io/badge/release-unreleased-red)
[![RimWorld 1.6](https://img.shields.io/badge/RimWorld-1.6-green.svg)](http://rimworldgame.com/)
[![Discord](https://img.shields.io/badge/Discord-Join%20Us-7289da?logo=discord&logoColor=white)](https://discord.gg/XcgBf3AbPa)

> The core framework mod for the Fallout Collaboration Project, bringing the Fallout universe to RimWorld.

---

> [!WARNING]
> This mod is in an **unstable early testing phase**. It may break saves, cause errors, or not work at all. Use at your own risk and keep backups of your saves.

> [!WARNING]
> The Steam Workshop versions of FCP mods are significantly out of date. **Do not mix Steam and GitHub versions** across the FCP, either use GitHub or Steam versions for all of them.

---

## Requirements

| Dependency | Required |
|------------|----------|
| RimWorld 1.6 | Yes      |
| Harmony | Yes      |
| All DLC* | Yes      |

*\*Biotech is heavily utilized throughout the mod. Royalty features are also used. We will not hold back from using other DLC features where needed.*

## Installation

### Recommended: FCP Mod Updater
Use the official updater tool to easily install and keep FCP-Tools up to date:

**[FCP Mod Updater](https://github.com/FalloutCollaborationProject/FCP-Mod-Updater)**

### Alternative (Manual Updates) Zip Files:
1. Download and extract to your RimWorld `Mods` folder
   - Click code -> download as zip file
   - This is located in your game install, for steam you can right click RimWorld -> manage -> browse local files
   - Extract so that your folders look like RimWorld/Mods/FCP-Tools-Main and FCP-Tools-Main has the About Folder
2. Download [FCP-UnityAssets](https://github.com/FalloutCollaborationProject/FCP-UnityAssets) separately and extract it into the `FCP-UnityAssets` folder inside the mod directory. The FCP Mod Updater does this automatically, but manual zip downloads do not include submodule contents.
3. Enable in the mod manager
4. Load after Harmony, and Core DLCs, but high up.

### Alternative: Git
```bash
#to install
cd /path/to/RimWorld/Mods
git clone --recurse-submodules https://github.com/FalloutCollaborationProject/FCP-Tools.git
```
```bash
#to update
git pull
```

---

## Credits

### Project Lead
**@RickGrymes / Ranger Rick** - Project Lead, C#, XML, Art, Writing

### Programming

#### Core Team
| Contributor | Focus       |
|-------------|-------------|
| Canonov | C# Work |
| Vitae | C# Work |
| Taranchuk | C# Work |
| RickGrymes | C#/XML Work |

#### Contributors
| Contributor | Contributions |
|-------------|---------------|
| SirMashedPotato | C# Work |
| Scurvyez | C# Work |
| Nalzurin | C# Work |
| Nimrag-b | C# Work |
| Lee | C# Work |
| Alexis P | C# Work |
| ViralReaction | C# Work |
| AlvalorDev | XML Contributions |
| Keyz182 | RATS/VATS Code |

### Art
DanDman, IcingWithCheesecake, Krazy4Games, RickGrymes

### Writing
Penumbra, RickGrymes

---

## Legal

Portions of the materials used to create this content/mod are trademarks and/or copyrighted works of **Bethesda Softworks LLC**. All rights reserved by Bethesda. This content/mod is not official and is not endorsed by Bethesda.

Portions of the materials used to create this content/mod are trademarks and/or copyrighted works of **Ludeon Studios Inc**. All rights reserved by Ludeon. This content/mod is not official and is not endorsed by Ludeon.

By forking, cloning, or pull requesting this software, you agree to grant **Ranger Rick** and the **Fallout Collaboration Project** a non transferable option to claim, for now and for ever more, your immortal soul. Should We wish to exercise this option, you agree to surrender your immortal soul, and any claim you may have on it, within 5 (five) working days of receiving written notification from the FCP or one of its duly authorised minions. We reserve the right to serve such notice in 6 (six) foot high letters of fire, however we can accept no liability for any loss or damage caused by such an act.