fenrir-wolfpack-simulation/README.md

Fenrir is an assistant to prognosticate the future of a wolfpack using vanilla Javascript and data structures.

# Fenrir Wolfpack Simulator
![alt text][logo]

[logo]: https://github.com/skywarth/Fenrir-wolfpack-simulator/blob/master/resc/fenrir-logo-black.png "Fenrir Wolfpack Simulator"

[![npm version](https://badge.fury.io/js/fenrir-wolfpack-simulation.svg)](https://badge.fury.io/js/fenrir-wolfpack-simulation) [![GitHub version](https://badge.fury.io/gh/skywarth%2FFenrir-wolfpack-simulator.svg)](https://badge.fury.io/gh/skywarth%2FFenrir-wolfpack-simulator) [![Licence](https://img.shields.io/github/license/skywarth/Fenrir-wolfpack-simulator.svg)](https://github.com/skywarth/Fenrir-wolfpack-simulator/blob/master/LICENSE) [![Known Vulnerabilities](https://snyk.io//test/github/skywarth/Fenrir-wolfpack-simulator/badge.svg?targetFile=package.json)](https://snyk.io//test/github/skywarth/Fenrir-wolfpack-simulator?targetFile=package.json) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/eed7a2a915f14a1a9cedfb22fb84fc59)](https://www.codacy.com/app/skywarth/Fenrir-wolfpack-simulator?utm_source=github.com&utm_medium=referral&utm_content=skywarth/Fenrir-wolfpack-simulator&utm_campaign=Badge_Grade) [![Maintainability](https://api.codeclimate.com/v1/badges/e6cb30155821937d3c47/maintainability)](https://codeclimate.com/github/skywarth/Fenrir-wolfpack-simulator/maintainability)

Fenrir is an assistant to prognosticate the future of a wolfpack using vanilla Javascript and data structures. 

### Simulation and prediction includes:
* Changes in the environment
* Health and status of individual wolves
* Disease conditions of each wolf
* Weather events and effects
* Alpha rankings in the pack
* Mortality status of pack members
* Wild card encounters (triggered by scout event)
* Meat distribution
* Regular events
* Irregular events



## Installation
```
npm i fenrir-wolfpack-simulation
```

## Demo
http://fenrir.yigit.kim/

**Demo of the current version doesn't have proper UI or interface design.** *To be designed in the future.*

## Current Version
Includes:
* Max-heap tree for alpha determination and food distribution.
* Regular Events.
* Environment module (partial).
* Constant parameters module.
* Modifiers module for chance and likelihood calculation.
* Variable parameter module.
* Wolf data module.
* Simulation module (initiating the simulation and generating reports).

Brief capabilities:
1. Create environment and it's object (input).
2. Create one or more wolf objects (input).
3. Calculate 7 hunt parameters which affect hunt success chance.
4. Determine alpha of the pack considering alpha points calculated.
5. Placement of wolf objects to max-heap tree according to alpha points.
6. Hunt event conclusion.
7. Food distribution order in pack.
8. Weather event trigger.
9. Scouting and results. (partial)
10. Basic simulation loop.

## License
Licenced under the [MIT License](https://github.com/skywarth/Fenrir-wolfpack-simulator/blob/master/LICENSE)