Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Smoked-Fish committed May 20, 2024
2 parents 73605a3 + 4b425b5 commit 3dd862a
Showing 1 changed file with 40 additions and 153 deletions.
193 changes: 40 additions & 153 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,175 +10,62 @@
- [Debug Commands](#debug-commands)

## Placing
- [Reset Page button](#reset-page-button)
- [Enable Placing](#enable-placing)
- [Place Anywhere](#place-anywhere)
- [Rug Removal Bypass](#rug-removal-bypass)
- [Wall Furniture Indoors](#wall-furniture-indoors)

##
| Setting Name | Description |
|------------------------|----------------|
| Reset Page Button | This button, located at the top of every page, resets the configuration for only that page. |
| Enable Placing | Toggle to enable the placement portion of the mod. Allows playing objects (chests, mini-fridges, fences) and furniture on any free tile. Enables infinite reach when placing furniture in all locations. |
| Place Anywhere | Toggle to enable placing objects and furniture inside walls or any other locked tile, with exceptions: cannot place objects on top of another object or inside the mines. |
| Rug Removal Bypass | Toggle to disable the check ensuring rugs don't have anything on top of them when picked up. Intended for use if unable to pick up a rug, disabling the checks. |
| Wall Furniture Indoors | Toggle to enable placing wall furniture anywhere indoors. By default off for easier indoor decorating, but can be enabled for unconventional placements like a window on your floor. |

##### `Reset Page Button`
This button is at the top of every page. it resets the config for only that page.

##### `Enable Placing`
This toggle enables the placement portion of the mod. When enabled you can play objects (chests, mini-fridges, fences) and furniture on any free tile.\
This also enables infinite reach when placing furniture in all locations so you can easily rearrange furniture.

##### `Place Anywhere`
This toggle enables placing objects and furniture inside of walls or any other locked tile with two exceptions.
* You cannot place objects on top of another object
* You cannot place objects or furniture inside of the mines

##### `Rug Removal Bypass`
This toggle disables the check that makes sure rugs don't have anything on top of them when picking them up.\
Its intended use is if for some reason you cannot pick up a rug you can disable the checks.

##### `Wall Furniture Indoors`
This enables placing wall furniture anywhere indoors. The default is off so decorating is easier indoors but if you want a window on your floor feel free to enable it.

## Building
- [Enable Building](#enable-building)
- [Build Anywhere](#build-anywhere)
- [Build Free & Instantly](#build-free--instantly)
- [Build Anywhere Menu](#build-anywhere-menu)
- [Wizard Build Menu](#wizard-build-menu)
- [Building Modifier Key](#building-modifier-key)
- [Enable Greenhouse](#enable-greenhouse)
- [Remove Build Conditions](#remove-build-conditions)
- [Build Indoors](#build-indoors)
- [Magic Ink Bypass](#magic-ink-bypass)
- [Hide Location](#hide-location)

##

##### `Enable Building`
This toggle enables all the building and menu features of the mod.

##### `Build Anywhere`
This toggle makes all tiles buildable, enabling you to build in walls or have buildings intersect each other.

##### `Build Free & Instantly`
This toggle will set the costs of all blueprints to be free and will make buildings build instantly.

##### `Build Anywhere Menu`
Opens up the carpenter menu anywhere. The viewport will be centered on the player.

##### `Wizard Build Menu`
Opens up the Wizards build menu anywhere. The viewport will be centered on the player.

##### `Building Modifier Key`
When this key is held down while you are building, upgrading, or destroying buildings, you will not be kicked out of the menu.\
This lets you build or destroy buildings really fast, no more waiting 15 seconds each time you want to build multiple fish ponds.\
Building or upgrading multiple buildings will still consume resources, you will be kicked out of the menu if you run out.

##### `Enable Greenhouse`
This toggle adds the Greenhouse as a blueprint that you can build. To unlock the blueprint you need to have the Greenhouse unlocked in the Community Center or the Joja path.\
The blueprint costs:
* 150,000 Gold
* 100 Hardwood
* 20 Refined Quartz
* 10 Iridium Bars

##### `Remove Build Conditions`
This toggle removes the build conditions on all blueprints. This lets you build things like the Island Obelisk without ever visiting the island.\
This works with mods that add buildings locked behind certain events too.

##### `Build Indoors`
This toggle enables building structures indoors. This can lead to errors.\
For example entering a building that you built inside of the coop will soft lock the game, requiring a restart.\
Building inside of the farmhouse and greenhouse does work though. If you have the Farmhouse Fixes mod make sure you enable `Non-Hardcoded Warps` in that mod.

##### `Magic Ink Bypass`
This toggle skips the check for magic ink when opening the Wizards build menu.\
This only works for this mods Wizards build menu, you sill need magic ink to open the Wizards menu at the tower.

##### `Hide Location`
This button will add the current player location to a list to not display in Robins build menu.\
When opening up the build menu the map properties "AlwaysActive" and "CanBuildHere" are set to true for the current location.\
To remove non blacklisted locations with no buildings from Robins menu, reload your save.

## Farming
- [Enable Farming](#enable-farming)
- [Hoe Anything](#hoe-anything)
- [Fruit Tree Tweaks](#fruit-tree-tweaks)
- [Wild Tree Tweaks](#wild-tree-tweaks)

##
| Setting Name | Description |
|------------------------|----------------|
| Enable Building | Toggle to enable all the building and menu features of the mod. |
| Build Anywhere | Toggle to make all tiles buildable, allowing building in walls or having buildings intersect each other. |
| Build Free & Instantly | Toggle to set the costs of all blueprints to be free and make buildings build instantly. |
| Build Anywhere Menu | Opens up the carpenter menu anywhere, with the viewport centered on the player. |
| Wizard Build Menu | Opens up the Wizard's build menu anywhere, with the viewport centered on the player. |
| Building Modifier Key | Holding down this key while building, upgrading, or destroying buildings prevents being kicked out of the menu, enabling fast building or destruction of multiple buildings. |
| Enable Greenhouse | Toggle to add the Greenhouse as a blueprint that can be built. Requires unlocking the Greenhouse in the Community Center or Joja path. Blueprint costs: 150,000 Gold, 100 Hardwood, 20 Refined Quartz, 10 Iridium Bars. |
| Remove Build Conditions | Toggle to remove build conditions on all blueprints, allowing building things like the Island Obelisk without visiting the island. Compatible with mods adding buildings locked behind certain events. |
| Build Indoors | Toggle to enable building structures indoors. Note: Can lead to errors, such as soft locking the game when entering a building built inside the coop. Works for buildings inside the farmhouse and greenhouse. If using the Farmhouse Fixes mod, ensure enabling "Non-Hardcoded Warps". |
| Magic Ink Bypass | Toggle to skip the check for magic ink when opening the Wizard's build menu. Only works for this mod's Wizard's build menu; magic ink is still required to open the Wizard's menu at the tower. |
| Hide Location | Button to add the current player location to a list to not display in Robin's build menu. Sets map properties "AlwaysActive" and "CanBuildHere" to true for the current location. To remove non-blacklisted locations with no buildings from Robin's menu, reload your save. |

##### `Enable Farming`
This toggle marks all locations as plantable, and makes most dirt tiles hoeable.\
This enables farming in all locations with dirt.\
Note that some dirt tiles added in 1.6 aren't labeled as dirt, and thus cannot be hoed, a simple fix for this is to enable the `Hoe Anything` toggle.

##### `Hoe Anything`
This toggle will let the player hoe any tile. This will make farming on stone or other non-dirt tiles possible.

##### `Fruit Tree Tweaks`
This toggle will remove the placement and growth restrictions on fruit trees.\
This will let you plant them as close together as you want and the growth won't be blocked by other trees or walls
## Farming
| Setting Name | Description |
|------------------------|----------------|
| Enable Farming | Toggle to mark all locations as plantable and make most dirt tiles hoeable. Enables farming in all locations with dirt. Note: Some dirt tiles added in 1.6 aren't labeled as dirt and cannot be hoed unless "Hoe Anything" is enabled. |
| Hoe Anything | Toggle to allow the player to hoe any tile, making farming on stone or other non-dirt tiles possible. |
| Fruit Tree Tweaks | Toggle to remove placement and growth restrictions on fruit trees, allowing planting them as close together as desired without growth being blocked by other trees or walls. |
| Wild Tree Tweaks | Toggle to remove placement and growth restrictions on wild trees, such as acorn, pine, maple, and mahogany seeds. Enabling this may cause wild trees to quickly grow out of control, leading to forest takeover. |

##### `Wild Tree Tweaks`
This toggle will remove the placement and growth restrictions on wild trees.\
This includes things like acorn, pine, maple, and mahogany seeds.\
Enabling this WILL make wild trees quickly grow out of control and you will be taken over by the forest.

## Miscellaneous
- [Animal Relocation](#animal-relocation)
- [Cask Tweaks](#cask-tweaks)
- [Jukebox Tweaks](#jukebox-tweaks)
- [Gold Clock Tweaks](#gold-clock-tweaks)
- [Multiple Mini-Obelisk](#multiple-mini-obelisk)

##

##### `Animal Relocation`
This toggle will enable the animal relocation menu.\
This is here so you can relocate animals to any location that has a building for them.\
If disabled animals can only be relocated to the main farm.
| Setting Name | Description |
|------------------------|----------------|
| Animal Relocation | Toggle to enable the animal relocation menu, allowing animals to be relocated to any location with a building for them. If disabled, animals can only be relocated to the main farm. |
| Cask Tweaks | Toggle to allow the player to use the cask outside of the cellar. Disabled by default due to potential perception as 'cheating' by some players. |
| Jukebox Tweaks | Toggle to enable using the jukebox in all locations it can be placed. Note: The jukebox does not work outside while it is raining. |
| Gold Clock Tweaks | Toggle to make the gold clock building work in any location, rather than just the farm. |
| Multiple Mini-Obelisk | Toggle to allow placing more than two mini-obelisks per location. Having more than two per location may cause them not to work as intended but can be used as decoration. If using the Multiple Mini-Obelisk mod, this toggle will be enabled by default; otherwise, it is disabled by default. |

##### `Cask Tweaks`
This toggle will let the player use the cask outside of the cellar.\
Its disabled by default as it can be seen as 'cheating' by some players.

##### `Jukebox Tweaks`
This toggle enables using the jukebox in all locations it can be placed.\
The jukebox does not work outside while it is raining.

##### `Gold Clock Tweaks`
This toggle lets the gold clock building work in any location, rather than just the farm.
## Debug Commands

##### `Multiple Mini-Obelisk`
This toggle lets you place more than two mini-obelisks per location.\
Having more than two per location will make the mini-obelisks not work as intended, but it can be used as decoration.\
If you have the Multiple Mini-Obelisk mod, this toggle will be enabled by default, otherwise it is disabled by default.


## Debug Commands
| Command | Description | Parameters |
|----------------------|------------------------------------------------------------------------|-----------------------------|
| `aa_remove_objects` | Removes all objects with a specified ID at a specified location. | `[LOCATION] [OBJECT_ID]` |
| `aa_remove_furniture`| Removes all furniture with a specified ID at a specified location. | `[LOCATION] [FURNITURE_ID]` |
| `aa_active` | Prints a list of all the locations that are set to AlwaysActive. | None |

These commands are executed in the SMAPI console. Use with caution and only if you understand their effects.

- `aa_remove_objects`
Removes all objects with a specified ID at a specified location.

Usage:
`aa_remove_objects [LOCATION] [OBJECT_ID]`

Example:
`aa_remove_objects current (O)499`

- `aa_remove_furniture`
Removes all furniture with a specified ID at a specified location.

Usage:
`aa_remove_furniture [LOCATION] [FURNITURE_ID]`

Example:
`aa_remove_furniture current (F)1371`

- `aa_active`
Prints a list of all the locations that are set to AlwaysActive

Usage:
`aa_active`

0 comments on commit 3dd862a

Please sign in to comment.