<!-- If you want to make changes to this README, you need to also modify the README.md in the docs folder as well -->

<h1 align="center">forge-client</h1>
<p align="center">
    <a href="https://github.com/IDSolutions/MOD_REPO/releases/latest">
        <img src="https://img.shields.io/badge/Version-0.0.0-blue?style=flat-square" alt="forge-client Version">
    </a>
    <a href="https://github.com/IDSolutions/MOD_REPO/issues">
        <img src="https://img.shields.io/github/issues-raw/IDSolutions/MOD_REPO.svg?style=flat-square&label=Issues" alt="forge-client Issues">
    </a>
    <a href="https://steamcommunity.com/sharedfiles/filedetails/?id=MOD_ID">
        <img src="https://img.shields.io/steam/downloads/MOD_ID.svg?style=flat-square&label=Downloads" alt="forge-client Downloads">
    </a>
    <a href="https://github.com/IDSolutions/MOD_REPO/blob/master/LICENSE">
        <img src="https://img.shields.io/badge/License-APL ND-red?style=flat-square" alt="forge-client License">
    </a>
    <br>
    <img src="https://img.shields.io/github/actions/workflow/status/IDSolutions/MOD_REPO/check.yml?style=flat-square&label=HEMTT" alt="HEMTT">
</p>

<p align="center">
    <b>Requires the latest version of <a href="https://github.com/CBATeam/CBA_A3/releases/latest">CBA A3</a></b>
</p>

# Initial Project Setup!

Delete this section after the project has been initially set up:

1. Find and replace all instances of `forge-client` with the mod's name.
2. Find and replace all instances of `MOD_REPO` with the mod's name _and no spaces_.
    - This should be the name of the repository on GitHub.
3. Find and replace all instances of `forge_client` with the mod's prefix.
    - This should be all lowercase.
4. Find and replace all instances of `MOD_ACRONYM` with the mod's acronym.
    - This should be all uppercase.
5. After the initial Steam upload, find and replace all instances of `MOD_ID` with the mod's Steam Workshop id.

For third parties, make sure to also replace `IDSolutions` with your Github username / organization name, and to replace `DartRuffian` with your username.

**forge-client** (MOD_ACRONYM) aims to...

The project is entirely **open-source** and any contributions are welcome.

## Core Features

- Feature

## Contributing

For new contributers, see the [Contributing Setup & Guidelines](./.github/CONTRIBUTING.md).

## License

forge-client is licensed under [APL-ND](./LICENSE.md).
