Skip to content

Commit

Permalink
doc: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
jcdcdev committed Apr 27, 2024
1 parent e6bc3ea commit 58d5d04
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
## jcdcdev.Eco.ShelfLife

![Eco Version](https://badgen.net/static/Eco/v0.10.3+/3a93b4)
![Eco Version](https://badgen.net/static/Eco/v0.10.2.1+/3a93b4)
[![Latest version on Github](https://badgen.net/github/tag/jcdcdev/jcdcdev.Eco.ShelfLife?color=3a93b4&label=Mod)](https://github.com/jcdcdev/jcdcdev.Eco.ShelfLife/releases/latest)

Control the shelf life multiplier of your storage objects in Eco.

## Install Steps

- Download the latest version of this mod from [mod.io](https://mod.io/g/eco/m/jcdcdevecoshelflife)
Expand All @@ -14,10 +16,10 @@
- On first run the server will shutdown
- This is expected behaviour ✅
- Please restart your server

## Configuration

You can use the Server UI or the config file `jcdcdev.Eco.ShelfLife.eco` to make changes.
## Configuration

You can configure the shelf life multiplier through the Server UI or directly in the config file.

**You must restart the server after making changes.**

Expand All @@ -28,9 +30,32 @@ The default values are the same as the vanilla game:
- `IndustrialRefrigerator`: 1.5
- `StorageSilo`: 1.2
- `PoweredStorageSilo`: 1.5
- `SeedBank`: 4.0 - (Requires jcdcdev.Eco.SeedStorage)
- `WoodenSeedBox`: 1.5 - (Requires jcdcdev.Eco.SeedStorage)
- `SeedBank`: 4.0 - (Requires [jcdcdev.Eco.SeedStorage](https://mod.io/g/eco/m/jcdcdevecoseedstorage))
- `WoodenSeedBox`: 1.5 - (Requires [jcdcdev.Eco.SeedStorage](https://mod.io/g/eco/m/jcdcdevecoseedstorage))

### Server UI

You can change these values to your needs, but keep in mind that higher values will make the items last longer and lower values will make them spoil faster.

You will notice that different storage containers will have different effects on the shelf life of the items stored in them. You can check the remaining shelf life of an item by hovering over it in your inventory or storage UI.
![Server UI](https://raw.githubusercontent.com/jcdcdev/jcdcdev.Eco.ShelfLife/main/docs/screenshots/2-config.png)

### Config File

You can find the config file at `./Configs/jcdcdev.Eco.ShelfLife.eco`.

The default values are below:

```json
{
"Icebox": 2.0,
"Refrigerator": 2.5,
"IndustrialRefrigerator": 3.0,
"StorageSilo": 2.0,
"PoweredStorageSilo": 3.0,
"SeedBank": 4.0,
"WoodenSeedBox": 2.0
}
```

You will notice that different storage containers will have different effects on the shelf life of the items stored in them. You can check the remaining shelf
life of an item by hovering over it in your inventory or storage UI.

0 comments on commit 58d5d04

Please sign in to comment.