README.md from BUTR/Bannerlord.PHP

README.md
Summary

Maintainability

Test Coverage

Issues
# Bannerlord.PHP
<p align="center">
  <a href="https://github.com/BUTR/Bannerlord.PHP" alt="Logo">
    <img src="https://staticdelivery.nexusmods.com/mods/3174/images/4254/4254-1659045338-1436194820.png" />
  </a>
  </br>
  <a href="https://github.com/BUTR/Bannerlord.PHP" alt="Lines Of Code">
    <img src="https://aschey.tech/tokei/github/BUTR/Bannerlord.PHP?category=code" />
  </a>
  <a href="https://www.codefactor.io/repository/github/butr/bannerlord.php">
    <img src="https://www.codefactor.io/repository/github/butr/bannerlord.php/badge" alt="CodeFactor" />
  </a>
  <a href="https://codeclimate.com/github/BUTR/Bannerlord.PHP/maintainability">
    <img alt="Code Climate maintainability" src="https://img.shields.io/codeclimate/maintainability-percentage/BUTR/Bannerlord.PHP">
  </a>
  </br>
  <a href="https://codecov.io/gh/BUTR/Bannerlord.PHP">
    <img src="https://codecov.io/gh/BUTR/Bannerlord.PHP/branch/dev/graph/badge.svg" />
  </a>
  </br>
  <a href="https://www.nexusmods.com/mountandblade2bannerlord/mods/4254" alt="NexusMods PHP">
    <img src="https://img.shields.io/badge/NexusMods-PHP%20Support-yellow.svg" />
  </a>  
  <a href="https://www.nexusmods.com/mountandblade2bannerlord/mods/4254" alt="NexusMods PHP">
    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fnexusmods-version-pzk4e0ejol6j.runkit.sh%3FgameId%3Dmountandblade2bannerlord%26modId%3D4254" />
  </a>
  <a href="https://www.nexusmods.com/mountandblade2bannerlord/mods/4254" alt="NexusMods PHP">
    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fnexusmods-downloads-ayuqql60xfxb.runkit.sh%2F%3Ftype%3Dunique%26gameId%3D3174%26modId%3D4254" />
  </a>
  <a href="https://www.nexusmods.com/mountandblade2bannerlord/mods/4254" alt="NexusMods PHP">
    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fnexusmods-downloads-ayuqql60xfxb.runkit.sh%2F%3Ftype%3Dtotal%26gameId%3D3174%26modId%3D4254" />
  </a>
  <a href="https://www.nexusmods.com/mountandblade2bannerlord/mods/4254" alt="NexusMods PHP">
    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fnexusmods-downloads-ayuqql60xfxb.runkit.sh%2F%3Ftype%3Dviews%26gameId%3D3174%26modId%3D4254" />
  </a>
  </br>
</p>

This is an experimental module for installing modules written in PHP that uses [PeachPie](https://peachpie.io/).  
Requires [BUTRLoader](https://www.nexusmods.com/mountandblade2bannerlord/mods/2513) v1.8.3 to be installed and the game to be run via [BUTRLoader](https://www.nexusmods.com/mountandblade2bannerlord/mods/2513). We will try to create a workaround for running the game via Vortex in the future.
## For Players
Make sure that [BUTRLoader](https://www.nexusmods.com/mountandblade2bannerlord/mods/2513) is installed and the game is run via [BUTRLoader](https://www.nexusmods.com/mountandblade2bannerlord/mods/2513).
## For Modders
Use [this](https://github.com/BUTR/Bannerlord.PHP/tree/master/src/Bannerlord.PHPExample) as an example of how to create a PHP module. We'll create a dotnet template once we are sure the template is correct.  
We don't have anyone who knows PHP enough to provide support. Please check [PeackPie documentation](https://docs.peachpie.io/) on how to interact with C#, the documentation contains enough examples.  
Please note that PeackPie does not provide all features of PHP! [Check the compatibility status](https://docs.peachpie.io/compatibility-status/)!