Updated documentation - v1.1.0
This commit is contained in:
@@ -6,7 +6,7 @@
|
|||||||
<RootNamespace>AutoRefillFires</RootNamespace>
|
<RootNamespace>AutoRefillFires</RootNamespace>
|
||||||
<LangVersion>latest</LangVersion>
|
<LangVersion>latest</LangVersion>
|
||||||
|
|
||||||
<PluginVersion>1.0.0</PluginVersion>
|
<PluginVersion>1.1.0</PluginVersion>
|
||||||
|
|
||||||
<ValheimPath>D:\SteamLibrary\steamapps\common\Valheim</ValheimPath>
|
<ValheimPath>D:\SteamLibrary\steamapps\common\Valheim</ValheimPath>
|
||||||
<R2ProfileName>Default</R2ProfileName>
|
<R2ProfileName>Default</R2ProfileName>
|
||||||
|
|||||||
@@ -1,33 +1,77 @@
|
|||||||
|
|
||||||
# Auto Refill Fires
|
# Auto Refill Fires
|
||||||
|
|
||||||
A lightweight BepInEx mod for Valheim that automatically refills nearby fireplaces and torches.
|
A lightweight BepInEx mod for Valheim that automatically refills nearby fireplaces and torches.
|
||||||
|
|
||||||
|
## Changelog - v1.1.0
|
||||||
|
##### [Full CHANGELOG](https://github.com/LabodiDavid/AutoRefillFires/blob/main/Thunderstore/CHANGELOG.md)
|
||||||
|
- Added configurable toggle hotkey (`F7` by default)
|
||||||
|
- Added `KeepFuelReserve` to keep a minimum amount of fuel untouched
|
||||||
|
- Added fuel source priority:
|
||||||
|
- `PlayerFirst`
|
||||||
|
- `ContainersFirst`
|
||||||
|
- Added setting for bonfires
|
||||||
|
- Nearby containers are used from closest to farthest
|
||||||
|
- Added `OnlyRefillOwnPieces` (setting to refill only fires what you built)
|
||||||
|
- Added configurable log levels
|
||||||
|
- Optimized container scanning, fire detection
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Automatically refills nearby campfires
|
- Automatically refills campfires, hearths, torches, braziers, bonfires and other compatible fireplaces
|
||||||
- Automatically refills hearths
|
- Automatically uses the correct fuel type
|
||||||
- Automatically refills standing torches, including colored variants
|
- Can use fuel from the player inventory and nearby containers
|
||||||
- Automatically refills wall torches
|
- Configurable refill radius and threshold
|
||||||
- Automatically refills braziers
|
|
||||||
- Uses the correct fuel type automatically
|
|
||||||
- Can consume fuel from the player's inventory
|
|
||||||
- Optional support for nearby containers
|
|
||||||
- Configurable refill radius
|
|
||||||
- Configurable refill threshold
|
|
||||||
- Refill to maximum or by a fixed amount
|
- Refill to maximum or by a fixed amount
|
||||||
- Individual enable/disable options for fireplace types
|
- Individual enable/disable options for fireplace types
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- Valheim
|
|
||||||
- BepInExPack Valheim
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The configuration file is generated after launching the game once with the mod installed.
|
The configuration file is generated after launching the game once with the mod installed.
|
||||||
|
|
||||||
`BepInEx/config/simplifydave.autorefillfires.cfg`
|
`BepInEx/config/simplifydave.autorefillfires.cfg`
|
||||||
|
|
||||||
|
### Hotkey
|
||||||
|
|
||||||
|
Default:
|
||||||
|
|
||||||
|
`F7`
|
||||||
|
|
||||||
|
Pressing the hotkey toggles Auto Refill Fires on or off.
|
||||||
|
|
||||||
|
When disabled, the configuration file is automatically reloaded, allowing most settings to be changed without restarting Valheim.
|
||||||
|
|
||||||
|
### Fuel Reserve
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
`KeepFuelReserve = 10`
|
||||||
|
|
||||||
|
The mod will leave the last 10 matching fuel items untouched in each fuel source.
|
||||||
|
|
||||||
|
### Fuel Source Priority
|
||||||
|
|
||||||
|
Available values:
|
||||||
|
|
||||||
|
`PlayerFirst`
|
||||||
|
|
||||||
|
`ContainersFirst`
|
||||||
|
|
||||||
|
If the preferred source does not contain enough usable fuel, the other source is used automatically.
|
||||||
|
|
||||||
|
### Logging
|
||||||
|
|
||||||
|
Available levels:
|
||||||
|
|
||||||
|
`None`, `Error`, `Warning`, `Info`, `Debug`
|
||||||
|
|
||||||
|
Use `Debug` to see fireplace detection, fuel levels, refill decisions and fuel source selection.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Valheim
|
||||||
|
- BepInExPack Valheim
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install using r2modman / Thunderstore Mod Manager, or manually place `AutoRefillFires.dll` inside:
|
Install using r2modman / Thunderstore Mod Manager, or manually place `AutoRefillFires.dll` inside:
|
||||||
|
|||||||
+67
-10
@@ -1,20 +1,77 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## 1.0.0
|
All notable changes to Auto Refill Fires will be documented in this file.
|
||||||
|
|
||||||
|
## [1.1.0] - 2026-08-29
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Added a configurable toggle hotkey.
|
||||||
|
- Default: `F7`
|
||||||
|
- Allows automatic refilling to be enabled or disabled while in-game.
|
||||||
|
- The configuration file is automatically reloaded when Auto Refill Fires is disabled, allowing settings to be changed without restarting the game.
|
||||||
|
|
||||||
|
- Added configurable logging levels:
|
||||||
|
- `None`
|
||||||
|
- `Error`
|
||||||
|
- `Warning`
|
||||||
|
- `Info`
|
||||||
|
- `Debug`
|
||||||
|
|
||||||
|
- Added `KeepFuelReserve`.
|
||||||
|
- Prevents Auto Refill Fires from consuming the last configured amount of fuel from player inventories and containers.
|
||||||
|
- Example: a reserve of `10` means the last 10 Wood, Resin, or other fuel items will be kept.
|
||||||
|
|
||||||
|
- Added configurable fuel source priority:
|
||||||
|
- `PlayerFirst`
|
||||||
|
- `ContainersFirst`
|
||||||
|
|
||||||
|
- Added support for using multiple nearby containers during a single refill.
|
||||||
|
- Fuel is taken from the nearest usable containers first.
|
||||||
|
- If the selected source cannot provide enough fuel, the plugin automatically falls back to the other configured source.
|
||||||
|
|
||||||
|
- Added `OnlyRefillOwnPieces`.
|
||||||
|
- Optionally restricts automatic refilling to fireplaces and torches built by the local player.
|
||||||
|
|
||||||
|
- Added more detailed Debug logging for:
|
||||||
|
- Fireplace detection
|
||||||
|
- Range checks
|
||||||
|
- Fuel levels and refill decisions
|
||||||
|
- Fuel source selection
|
||||||
|
- Nearby container availability
|
||||||
|
- Fuel consumption
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Significantly reduced unnecessary container scanning.
|
||||||
|
- Containers are now discovered once per refill scan cycle and reused for all fireplaces during that cycle.
|
||||||
|
- A container is no longer rediscovered once for every individual fuel item added.
|
||||||
|
|
||||||
|
- Fuel is now removed in batches instead of one item at a time where possible.
|
||||||
|
|
||||||
|
- Nearby containers are sorted by distance and the closest usable container is preferred.
|
||||||
|
|
||||||
|
- Improved fireplace type detection.
|
||||||
|
- Vanilla campfires using the `fire_pit` prefab are correctly recognized as campfires.
|
||||||
|
|
||||||
|
- Improved handling of unknown and modded objects based on Valheim's `Fireplace` component.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Fixed excessive scene-wide container searches when refilling fireplaces to maximum fuel.
|
||||||
|
- Fixed campfires potentially being classified as `OtherFireplaces` because of their vanilla prefab name.
|
||||||
|
- Fixed Debug messages being hidden by the default BepInEx Debug log filter.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.0.0] - 2026-08-23
|
||||||
|
|
||||||
Initial release.
|
Initial release.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Automatic campfire refilling
|
- Automatic campfire, hearth, standing/wall torch, brazier refilling
|
||||||
- Automatic hearth refilling
|
|
||||||
- Automatic standing torch refilling
|
|
||||||
- Automatic wall torch refilling
|
|
||||||
- Automatic brazier refilling
|
|
||||||
- Supports colored torch variants
|
|
||||||
- Automatically detects the required fuel type
|
|
||||||
- Optional nearby container fuel usage
|
- Optional nearby container fuel usage
|
||||||
- Configurable refill radius
|
- Configurable refill radius, treshold
|
||||||
- Configurable refill threshold
|
|
||||||
- Refill-to-max or fixed refill amount
|
- Refill-to-max or fixed refill amount
|
||||||
- Individual fireplace type toggles
|
- Individual fireplace type toggles
|
||||||
+59
-15
@@ -1,33 +1,77 @@
|
|||||||
|
|
||||||
# Auto Refill Fires
|
# Auto Refill Fires
|
||||||
|
|
||||||
A lightweight BepInEx mod for Valheim that automatically refills nearby fireplaces and torches.
|
A lightweight BepInEx mod for Valheim that automatically refills nearby fireplaces and torches.
|
||||||
|
|
||||||
|
## Changelog - v1.1.0
|
||||||
|
##### [Full CHANGELOG](https://github.com/LabodiDavid/AutoRefillFires/blob/main/Thunderstore/CHANGELOG.md)
|
||||||
|
- Added configurable toggle hotkey (`F7` by default)
|
||||||
|
- Added `KeepFuelReserve` to keep a minimum amount of fuel untouched
|
||||||
|
- Added fuel source priority:
|
||||||
|
- `PlayerFirst`
|
||||||
|
- `ContainersFirst`
|
||||||
|
- Added setting for bonfires
|
||||||
|
- Nearby containers are used from closest to farthest
|
||||||
|
- Added `OnlyRefillOwnPieces` (setting to refill only fires what you built)
|
||||||
|
- Added configurable log levels
|
||||||
|
- Optimized container scanning, fire detection
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Automatically refills nearby campfires
|
- Automatically refills campfires, hearths, torches, braziers, bonfires and other compatible fireplaces
|
||||||
- Automatically refills hearths
|
- Automatically uses the correct fuel type
|
||||||
- Automatically refills standing torches, including colored variants
|
- Can use fuel from the player inventory and nearby containers
|
||||||
- Automatically refills wall torches
|
- Configurable refill radius and threshold
|
||||||
- Automatically refills braziers
|
|
||||||
- Uses the correct fuel type automatically
|
|
||||||
- Can consume fuel from the player's inventory
|
|
||||||
- Optional support for nearby containers
|
|
||||||
- Configurable refill radius
|
|
||||||
- Configurable refill threshold
|
|
||||||
- Refill to maximum or by a fixed amount
|
- Refill to maximum or by a fixed amount
|
||||||
- Individual enable/disable options for fireplace types
|
- Individual enable/disable options for fireplace types
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- Valheim
|
|
||||||
- BepInExPack Valheim
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The configuration file is generated after launching the game once with the mod installed.
|
The configuration file is generated after launching the game once with the mod installed.
|
||||||
|
|
||||||
`BepInEx/config/simplifydave.autorefillfires.cfg`
|
`BepInEx/config/simplifydave.autorefillfires.cfg`
|
||||||
|
|
||||||
|
### Hotkey
|
||||||
|
|
||||||
|
Default:
|
||||||
|
|
||||||
|
`F7`
|
||||||
|
|
||||||
|
Pressing the hotkey toggles Auto Refill Fires on or off.
|
||||||
|
|
||||||
|
When disabled, the configuration file is automatically reloaded, allowing most settings to be changed without restarting Valheim.
|
||||||
|
|
||||||
|
### Fuel Reserve
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
`KeepFuelReserve = 10`
|
||||||
|
|
||||||
|
The mod will leave the last 10 matching fuel items untouched in each fuel source.
|
||||||
|
|
||||||
|
### Fuel Source Priority
|
||||||
|
|
||||||
|
Available values:
|
||||||
|
|
||||||
|
`PlayerFirst`
|
||||||
|
|
||||||
|
`ContainersFirst`
|
||||||
|
|
||||||
|
If the preferred source does not contain enough usable fuel, the other source is used automatically.
|
||||||
|
|
||||||
|
### Logging
|
||||||
|
|
||||||
|
Available levels:
|
||||||
|
|
||||||
|
`None`, `Error`, `Warning`, `Info`, `Debug`
|
||||||
|
|
||||||
|
Use `Debug` to see fireplace detection, fuel levels, refill decisions and fuel source selection.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Valheim
|
||||||
|
- BepInExPack Valheim
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install using r2modman / Thunderstore Mod Manager, or manually place `AutoRefillFires.dll` inside:
|
Install using r2modman / Thunderstore Mod Manager, or manually place `AutoRefillFires.dll` inside:
|
||||||
|
|||||||
Reference in New Issue
Block a user