Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kennipj committed Jul 1, 2022
1 parent 0b2c339 commit f2f45b9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# About
This is a mod for Good Company, adding more features for courier related actions.


# Features
* Adds an `Add Route` button to the courier pallet that creates a new route with the selected pallet and its reserved item slots.

# Installing
1. Ensure [GCModLoader](https://github.com/SeppahBaws/GoodCompanyModLoader) is installed.
2. Grab the `BetterCouriers.dll` from the [latest release](https://github.com/kennipj/gc-better-couriers/releases/latest), and put it in the `<GoodCompanyDir>\GCModLoader\Mods` directory.
3. Add the mod to `<GoodCompanyDir>\GCModLoader\ModsConfig.json`.
```json
{
"Name": "BetterCouriers",
"File": "BetterCouriers.dll",
"Enabled": true
}
```

0 comments on commit f2f45b9

Please sign in to comment.