Skip to content

Commit 9184ece

Browse files
author
Manpreet "Mannie" Singh
authored
Update README.md
- Update information regarding AutoFence/AutoFenceGate - Move installation instructions from release to the README - Move config description to be right below the installation instructions
1 parent 92d3afb commit 9184ece

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@ Features
66
- No more accidentally dismounting your horse while trying to open a fence gate
77
- That's about the only discernable difference, except the presence of the tiny ghost that hurriedly closes the fence gates behind you
88

9-
Click <a href="https://github.com/CoronaSophium/Passage/releases/latest" target="_blank">here</a> for the least release's download and instructions.
10-
9+
Installation
1110
---
12-
I made this mod out of a random necessity I personally encountered while playing Stardew Valley and learning C# and Stardew Valley modding. Turns out, however, there's another mod out there that accomplishes the same thing: `AutoGate` by Teban100/eroticremix [[Nexus Mods](https://rd.nexusmods.com/stardewvalley/mods/820/?) - [Forums](https://community.playstarbound.com/threads/autogate-automatically-opening-closing-gates.129074/)]. Whoops. Other than `AutoGate`'s lack of a config, the two mods are pretty much the same in functionality. I have yet to make any comparisons in performance or timings, however.
11+
1. Install [SMAPI](https://github.com/Pathoschild/SMAPI/releases/latest) (tested using SMAPI v2.1)
12+
2. Download Passage's latest release from [here](https://github.com/CoronaSophium/Passage/releases/latest), and extract it to `Stardew Valley/Mods`
13+
*_(optional)_*
14+
3. Launch Stardew Valley with SMAPI once to generate Passge configuration file
15+
4. Edit `Stardew Valley/Mods/Passage/config.json` to your heart's content
1316

14-
## Config
17+
Config
18+
---
1519
Checkout `Stardew Valley/Mods/Passage/config.json` for mod configuration:
1620

1721
| Default | Description | Name |
@@ -20,6 +24,12 @@ Checkout `Stardew Valley/Mods/Passage/config.json` for mod configuration:
2024
| [bool]: **true** | while enabled, makes fence gates automatically open as you approach, and close as you leave them behind | **EnableAutoFenceGateManagement** |
2125
| [bool]: **false** | while enabled, requires you to be riding a horse for the automatic fence management to occur | **OnlyOpenFenceGateWhileRidingHorse** |
2226
| [float]: **1.1** | this is how far you must travel away from a fence gate for it to automatically close behind you, after having been automatically opened by walking into | **MaxDistanceToKeepFenceGateOpen** |
27+
28+
AutoFence
29+
---
30+
I made this mod out of a random necessity I personally encountered while playing Stardew Valley and learning C# and Stardew Valley modding. ~~Turns out, however, there's another mod out there that accomplishes the same thing: ~~`AutoGate` by Teban100/eroticremix [[Nexus Mods](https://rd.nexusmods.com/stardewvalley/mods/820/?) - [Forums](https://community.playstarbound.com/threads/autogate-automatically-opening-closing-gates.129074/)].
31+
32+
I've rewritten the mod since its initial release and renamed it from "AutoFenceGate" to "Passage". While AutoFenceGate and AutoFence used to share 100% of their features (bar any configuration differences), Passage now _also_ supports auto-interaction with doors.
2333
<br />
2434
<br />
2535
<hr />

0 commit comments

Comments
 (0)