Skip to content

Commit

Permalink
doc: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeFwd committed Oct 27, 2024
1 parent 1638b5d commit c81c51e
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Dellarte Della Guerra

Dellarte Della Guerra (DADG) is an upcoming mod for *Mount and Blade II: Bannerlord*, setting the stage for the English War of the Roses in 1471, opposing the House of York and Lancaster for the English crown.

## Acknowledgements

The mod will integrate and build upon features for jousts, firearms, and cannons from **The Old Realms** mod. You can find the original implementation and details here: [The Old Realms Mod](https://github.com/TheOldRealms/TOR_Core/tree/development).

We believe that open-sourcing our codebase will also enable other mods to build upon it effectively. However, please note that all XML and assets related to this mod are not available publicly.

## Planned Features

See our [open issues](https://github.com/DellarteDellaGuerraTeam/DellarteDellaGuerra.Core/labels/enhancement) for a list of features we plan to implement.

## Dependencies

- **Bannerlord.Harmony**: Required for patching and mod integration capabilities.
- **POC Colour Randomiser Mod**: Essential for customising heraldry, coats of arms, and liveries.
- **Bannerlord.ExpandedTemplate**: Utilised for implementing siege templates and managing equipment pools effectively.
- **BUTR Bannerlord Template**: Used for development purposes.

## Contributing

We welcome contributions! If you would like to help improve DADG, feel free to join our [Discord](https://discord.gg/ZVye6tDqyC).

## Licence

This mod is released under the [GPL V3](LICENSE).

0 comments on commit c81c51e

Please sign in to comment.