zero-engine/README.md

<center><img src="https://raw.githubusercontent.com/fvtt-fria-ligan/blade-runner-foundry-vtt/main/static/assets/blade-runner-banner-small.webp"/></center>
<h1 align="center"><b>Blade Runner - The Roleplaying Game</b><br/><small>🎲 <i>Foundry VTT</i> 🎲</small></h1>
<p align="center">
  <img alt="Version" src="https://img.shields.io/badge/dynamic/json?color=blue&label=version&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2Ffvtt-fria-ligan%2Fblade-runner-foundry-vtt%2Fmain%2Fstatic%2Fsystem.json"/>
  <a href="https://foundryvtt.com" target="_blank">
    <img alt="Foundry Version" src="https://img.shields.io/badge/dynamic/json?color=blue&label=Foundry&query=compatibility.minimum&url=https%3A%2F%2Fraw.githubusercontent.com%2Ffvtt-fria-ligan%2Fblade-runner-foundry-vtt%2Fmain%2Fstatic%2Fsystem.json"/>
  </a>
  <a href="https://foundryvtt.com/packages/blade-runner/" target="_blank">
    <img alt="Forge Installs" src="https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2Fblade-runner&colorB=4aa94a"/>
  </a>
  <a href="https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/releases">
    <img alt="Downloads" src="https://img.shields.io/badge/dynamic/json?label=Downloads@latest&query=assets[?(@.name.includes('zip'))].download_count&url=https://api.github.com/repos/fvtt-fria-ligan/blade-runner-foundry-vtt/releases/latest&color=green"/>
  </a>
  <a href="https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg"/>
  </a>
  <a href="https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/blob/main/LICENSE" target="_blank">
    <img alt="License: GPLv3" src="https://img.shields.io/badge/License-GPLv3-orange"/>
  </a>
  <a href="https://www.patreon.com/Stefouch">
    <img src="https://img.shields.io/badge/Donate-Patreon-F96854.svg" alt="Patreon">
  </a>
</p>

> The **OFFICIAL** game system for the **Blade Runner RPG** on Foundry VTT!

# 📦 What's in the Box?

The core system features no content. It only provides support for various mechanics required to play the game:

- Dice roller
- Actor sheets:
  - Character (PC & NPC)
  - Vehicle
  - Loot (item pile)
- Item sheets:
  - Generic
  - Armor
  - Weapon
  - Explosive
  - Specialty
  - Synthetic Augment
  - Critical Injury

# 🚀 Install

## System

> **Note**: The game system is compatible with Foundry **V10** & **V11**.

1. Go to the setup page in Foundry and choose `Game Systems`
2. Click the `Install System` and search for "Blade Runner", or paste in this [manifest link](https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/releases/latest/download/system.json)
3. Create a `Game World` using the Blade Runner system and start it
4. Read the _Game System's Manual_ Journal Entry in the system's compedium
5. _Enjoy!_

## Premium Modules

> **Note**: Premium modules are not mandatory to play the game as the game system is free to use, but they will save you _weeks_ of preparation.

1. Get the premium modules at the [Free League's shop](https://freeleaguepublishing.com/en/store/?collection_id=405939749122)
2. Retrieve your codes in your mail box _(contact Free League if you did not recieve anything after 15 minutes, also check your spam box)_
3. Activate the codes in your Foundry account: visit [foundryvtt.com](https://foundryvtt.com/), go to your account settings, in _"Purchased Content"_, and paste in the codes
4. Launch the Foundry client _(and make sure you have updated Foundry to V10)_
5. Install the Blade Runner premium modules and some of the recommended third-party modules _(optional, see below)_
6. Create a new World with the Blade Runner system and start it
7. In the options, activate the modules
8. Refresh and import the content. _Have fun!_

# 🧩 Supported Modules

List of modules confirmed to be stable with the Blade Runner game system:

- [Dice So Nice](https://foundryvtt.com/packages/dice-so-nice/): Enables the Blade Runner 3D dice. Also, a set of predefined Special Effects is available in the `/assets/plugins` folder. _(Use the import button in the DsN settings.)_
- [Year Zero Engine: Combat](https://foundryvtt.com/packages/yze-combat): Combat mechanics with initiative cards.
- [Simultaneous Cards](https://foundryvtt.com/packages/simultaneous-cards): Useful for chases.
- [Simple Calendar](https://foundryvtt.com/packages/foundryvtt-simple-calendar): Tracks time, useful for the investigation's time table.
- [Item Piles](https://foundryvtt.com/packages/item-piles): Useful for creating merchants and RDU services providers.
- [Token Action HUD](https://foundryvtt.com/packages/token-action-hud-core) with [this plugin](https://foundryvtt.com/packages/token-action-hud-bladerunner)
- [Quick Insert - Search Widget](https://foundryvtt.com/packages/quick-insert): Quickly search content.

List of premium content modules:

- [Blade Runner RPG Core Rules](https://foundryvtt.com/packages/blade-runner-core-game)
- [Blade Runner RPG Starter Set](https://foundryvtt.com/packages/blade-runner-starter-set)
- [Blade Runner RPG Fiery Angels](https://foundryvtt.com/packages/blade-runner-fiery-angels)

# 🛠️ Contributing

If you want to contribute to the project, download and build it for something else, or if you simply have an issue, please read [our contributing guide](https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/blob/main/CONTRIBUTING.md) to learn more about how we accept contributions and how to set up the development version of the project.

## Translations

<a href="https://weblate.foundryvtt-hub.com/engage/blade-runner/">
<img src="https://weblate.foundryvtt-hub.com/widgets/blade-runner/-/multi-auto.svg" alt="Translation status" />
</a>

# 👤 Author

<p align="center">
  <a href="https://stefouch.be" target="_blank">
    <img src="https://raw.githubusercontent.com/fvtt-fria-ligan/blade-runner-foundry-vtt/main/static/assets/logos/BSL-D6_bannerlogo_H150.png" alt="Stefouch Gaming Lab" style="width: auto; height: auto; max-height: 100px;"/>
  </a>
  <br/>
  <i>Built by a fan, for the fans.</i>
</p>

# 👷 Maintainer

<p align="center">
  <a href="https://hodpub.com" target="_blank">
    <img src="static/assets/logos/hod-publishing.webp" alt="Hod Publishing" style="width: auto; height: auto; max-height: 250px;"/>
  </a>
</p>

# 🔗 See Also

- [Foundry VTT](https://foundryvtt.com/)
- [Blade Runner - The Roleplaying Game](https://bladerunner-rpg.com/)
- [Free League Publishing: Blade Runner](https://freeleaguepublishing.com/en/games/blade-runner/)
- Discord:
  - [The Foundry](https://discord.gg/foundryvtt)
  - [Year Zero Worlds](https://discord.gg/RnaydHR)
  - [Blade Runner RPG](https://discord.gg/fB9sUEsbgz)

# 📜 List of Changes

See the [changelog](https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/blob/master/CHANGELOG.md#changelog) for a complete list of changes applied to the system since 2022.

# 📝 Licenses

- **Content & Logo:** [Blade Runner - The Roleplaying Game](https://freeleaguepublishing.com/en/games/blade-runner/) is © 2022 Alcon Entertainment, LLC. All rights reserved. The parts of this project protected under this copyright may not be distributed commercially or freely. This includes art, logo, and copyright text.
- **Source Code:** All source code _(javascript, hbs, scss, as well as system templates and the like)_ are Copyright © 2022 [Stefouch](https://github.com/Stefouch), and licenced under the [GNU General Public License v3.0](https://github.com/fvtt-fria-ligan/blade-runner-foundry-vtt/blob/master/LICENSE).
- **Foundry VTT:** The project is created following the Foundry VTT [Limited License Agreement for module development](https://foundryvtt.com/article/license/).
- **Icons:** Icons in the `.static/assets/icons/` folder are courtesy of [Game-icons.net](https://game-icons.net/) and licenced under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/).
- **Fonts:** The fonts used in this project carry their own licences.