Skip to content

Commit 6b8410e

Browse files
committed
Release v1.1.0
1 parent 1995cf4 commit 6b8410e

15 files changed

+65
-53
lines changed

Docs/Docs.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
</None>
6262
<None Include="Modules\00Urls.t4" />
6363
<None Include="Modules\10Header.t4" />
64-
<None Include="Modules\11HeaderGitHub.t4" />
6564
<None Include="Modules\20Features.t4" />
6665
<None Include="Modules\30Installation.t4" />
6766
<None Include="Modules\40Bugs.t4" />

Docs/Modules/10Header.t4

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<#= mf.Heading(thisModName) #>
22

3-
XStorage lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
3+
XStorage <#= (target == Targets.GitHub) ? "is a Valheim mod that " : "" #>lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
44

5-
<#= mf.Image("https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-small.png", height: 500) #>
5+
<#= mf.Image("https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-v1.1.0-small.png", height: 480) #>

Docs/Modules/11HeaderGitHub.t4

Lines changed: 0 additions & 5 deletions
This file was deleted.

Docs/Modules/20Features.t4

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,17 @@
44

55
By pressing alt-interact (<#= mf.Code("Shift + E") #> by default), you can give your chests a name. This name is shown when you hover over the chest, and also in the panel above the inventory when a chest is opened.
66

7-
Chest names will be permanently stored in your world file. Uninstalling XStorage makes them go away, but after reinstalling they will be recovered.
8-
97
<#= mf.Heading("Open many chests", size: HeadingSize.Small) #>
108

11-
To display multiple chests, XStorage creates a new panel in the UI. Sadly there aren't enough pixels on the screen to make everything fit nicely, so there is a small overlap with existing UI panels. Hopefully I can address this in the future.
12-
13-
In theory there is no limit to how many chests XStorage can display. When the UI panel is full, XStorage makes the panel scrollable. In a future version, I might impose a restriction on how many chests can be opened though, as this could cause performance issues.
9+
To display multiple chests, XStorage creates a new panel in the UI. The panel will automatically expand to fit in as many chests as it can. You can restrict the width and height in XStorage's config.
1410

15-
Also on the roadmap are config options that let you configure the distance and methods that decide which chests are opened. One such method I have in mind is chest linking, i.e. every opened chests searches for other chests near it, so that you could open an entire row of chests from either end. For now, XStorage opens any chest that is within 5 meters of the player (again, with no maximum amount of chests).
11+
When you open more chests than XStorage can display on the screen, this panel will become scrollable.
1612

1713
<#= mf.Heading("Moving items/stacks to the most suitable chest", size: HeadingSize.Small) #>
1814

1915
When you auto-move an item from your inventory (via <#= mf.Code("Ctrl + Click") #>), XStorage tries to find the most suitable chest to put the item/stack in. It does so by picking the chest containing the highest quantity of the item you are moving, from all opened chests that still have free space.
20-
So if you have a wooden chest with 499 stone in it, and you `Ctrl + Click` on a stack of stone in your inventory, 1 stone will be moved to that chest. You have to then <#= mf.Code("Ctrl + Click") #> it again to make the rest go to the next most suitable chest.
2116

22-
<#= mf.Code("Ctrl + Click") #>-ing an item or stack in any of the chests will always make it go to the player inventory.
17+
<#= mf.Code("Ctrl + Click") #>-ing an item or stack in any of the chests will always make it go to the player inventory (equal to vanilla behaviour).
2318

2419
<#= mf.Heading("Multiplayer", size: HeadingSize.Small) #>
2520

@@ -31,7 +26,6 @@ There are a few things that, at this stage, XStorage does not do well, or at all
3126
<#=
3227
mf.List(ListBullets.Asterisk, items: new string[] {
3328
$"{mf.Bold("Gamepad input")}: XStorage does not deal with gamepad input at all. That is to say, the UI kind of breaks when you use a gamepad. I will look into this in the future, but for now this mod is pretty much mouse/keyboard only.",
34-
$"{mf.Bold("The panel does not fit")}: The XStorage UI panel does not fit within the vanilla UI very well. I am considering alternative ways of displaying the container panels (for example by overlapping or even removing the crafting panel. Does anyone even use that while opening a chest?)"
3529
})
3630
#>
3731

Docs/Modules/50Changelogs.t4

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
<#= mf.Heading("Changelogs") #>
22

3+
* **v1.1.0** (2023-03-11)
4+
5+
* Fix error when placing a new chest
6+
7+
* Fix a HarmonyX warning that occurs when loading XStorage; this was caused by a library I use locally to manage documentation, but XStorage does not ship with this library.
8+
9+
* Fix being able to rename chests that are protected by a ward
10+
11+
* UI overhaul:
12+
13+
* You can now drag the XStorage panel
14+
15+
* You can set the maximum panel size in XStorage's config file using MaxColumns and MaxRows. Default value is 2 columns by 3 rows. XStorage will still restrict the size by what fits on your screen.
16+
17+
* XStorage will store the position of the panel per grid size when you close the panel, so that next time you open a panel of the same size, it will be restored to that position on the screen.
18+
19+
* Many code improvements and optimisations
20+
21+
<details>
22+
<summary>Click to view previous versions</summary>
23+
324
* **v1.0.2** (2023-03-02)
425

526
* Fix tooltips not always being fully visible
@@ -8,9 +29,6 @@
829

930
* Reworked a large portion of the containers panel UI
1031

11-
<details>
12-
<summary>Click to view previous versions</summary>
13-
1432
* **v1.0.1** (2023-02-28)
1533

1634
* Remove "valheim.exe" check as it stops dedicated servers from loading the mod.

Docs/Modules/90InstallationDev.t4

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<#= mf.Heading("Installation instructions (for developers)") #>
22

3-
I will soon write a guide to get <#= thisModName #> working in your development environment. For now, you can probably figure some stuff out by having a look at the [J�tunnModStub](https://github.com/Valheim-Modding/JotunnModStub) project that <#= thisModName #> is based on. Please bear in mind that the information there might have changed since <#= thisModName #> was created, and that <#= thisModName #> itself may over time have diverted from the steps laid out there. Again, a guide will follow soon!
3+
I will soon write a guide to get <#= thisModName #> working in your development environment. For now, you can probably figure some stuff out by having a look at the [JotunnModStub](https://github.com/Valheim-Modding/JotunnModStub) project that <#= thisModName #> is based on. Please bear in mind that the information there might have changed since <#= thisModName #> was created, and that <#= thisModName #> itself may over time have diverted from the steps laid out there. Again, a guide will follow soon!

Docs/README.GitHub.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# XStorage
22

3-
XStorage is a Valheim mod lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
3+
XStorage is a Valheim mod that lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
44

5-
<img src="https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-small.png" height="500" />
5+
<img src="https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-v1.1.0-small.png" height="480" />
66

77

88
# Download and installation instructions (for players)
@@ -27,7 +27,7 @@ For feature requests, choose `Feature request` on the [New issue](https://github
2727

2828
# Installation instructions (for developers)
2929

30-
I will soon write a guide to get XStorage working in your development environment. For now, you can probably figure some stuff out by having a look at the [J?tunnModStub](https://github.com/Valheim-Modding/JotunnModStub) project that XStorage is based on. Please bear in mind that the information there might have changed since XStorage was created, and that XStorage itself may over time have diverted from the steps laid out there. Again, a guide will follow soon!
30+
I will soon write a guide to get XStorage working in your development environment. For now, you can probably figure some stuff out by having a look at the [JotunnModStub](https://github.com/Valheim-Modding/JotunnModStub) project that XStorage is based on. Please bear in mind that the information there might have changed since XStorage was created, and that XStorage itself may over time have diverted from the steps laid out there. Again, a guide will follow soon!
3131

3232

3333
# I did more too!

Docs/README.GitHub.tt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
target = Targets.GitHub;
66
#>
77
<#@ include file="Modules\00Urls.t4" once="true" #>
8-
<#@ include file="Modules\11HeaderGitHub.t4" once="true" #>
8+
<#@ include file="Modules\10Header.t4" once="true" #>
99

1010
<#@ include file="Modules\30Installation.t4" once="true" #>
1111

Docs/README.Nexus.bbcode

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
XStorage lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
44

5-
[img]https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-small.png[/img]
5+
[img]https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-v1.1.0-small.png[/img]
66

77

88
[size=6][b][color=#FFA03C]Features[/color][/b][/size]
@@ -11,22 +11,17 @@ XStorage lets you open multiple chests at once, rename them, and move items/stac
1111

1212
By pressing alt-interact ([font=Courier New][b]'Shift + E'[/b][/font] by default), you can give your chests a name. This name is shown when you hover over the chest, and also in the panel above the inventory when a chest is opened.
1313

14-
Chest names will be permanently stored in your world file. Uninstalling XStorage makes them go away, but after reinstalling they will be recovered.
15-
1614
[size=3][b][color=#FFA03C]Open many chests[/color][/b][/size]
1715

18-
To display multiple chests, XStorage creates a new panel in the UI. Sadly there aren't enough pixels on the screen to make everything fit nicely, so there is a small overlap with existing UI panels. Hopefully I can address this in the future.
19-
20-
In theory there is no limit to how many chests XStorage can display. When the UI panel is full, XStorage makes the panel scrollable. In a future version, I might impose a restriction on how many chests can be opened though, as this could cause performance issues.
16+
To display multiple chests, XStorage creates a new panel in the UI. The panel will automatically expand to fit in as many chests as it can. You can restrict the width and height in XStorage's config.
2117

22-
Also on the roadmap are config options that let you configure the distance and methods that decide which chests are opened. One such method I have in mind is chest linking, i.e. every opened chests searches for other chests near it, so that you could open an entire row of chests from either end. For now, XStorage opens any chest that is within 5 meters of the player (again, with no maximum amount of chests).
18+
When you open more chests than XStorage can display on the screen, this panel will become scrollable.
2319

2420
[size=3][b][color=#FFA03C]Moving items/stacks to the most suitable chest[/color][/b][/size]
2521

2622
When you auto-move an item from your inventory (via [font=Courier New][b]'Ctrl + Click'[/b][/font]), XStorage tries to find the most suitable chest to put the item/stack in. It does so by picking the chest containing the highest quantity of the item you are moving, from all opened chests that still have free space.
27-
So if you have a wooden chest with 499 stone in it, and you `Ctrl + Click` on a stack of stone in your inventory, 1 stone will be moved to that chest. You have to then [font=Courier New][b]'Ctrl + Click'[/b][/font] it again to make the rest go to the next most suitable chest.
2823

29-
[font=Courier New][b]'Ctrl + Click'[/b][/font]-ing an item or stack in any of the chests will always make it go to the player inventory.
24+
[font=Courier New][b]'Ctrl + Click'[/b][/font]-ing an item or stack in any of the chests will always make it go to the player inventory (equal to vanilla behaviour).
3025

3126
[size=3][b][color=#FFA03C]Multiplayer[/color][/b][/size]
3227

@@ -37,7 +32,6 @@ In multiplayer games, all players need to have XStorage installed, or it will no
3732
There are a few things that, at this stage, XStorage does not do well, or at all:
3833
[list]
3934
[*][b]Gamepad input[/b]: XStorage does not deal with gamepad input at all. That is to say, the UI kind of breaks when you use a gamepad. I will look into this in the future, but for now this mod is pretty much mouse/keyboard only.
40-
[*][b]The panel does not fit[/b]: The XStorage UI panel does not fit within the vanilla UI very well. I am considering alternative ways of displaying the container panels (for example by overlapping or even removing the crafting panel. Does anyone even use that while opening a chest?)
4135
[/list]
4236

4337
XStorage looks best when playing at a 16:9 ratio with a UI scaling of 95% or smaller.

Docs/README.Thunderstore.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
XStorage lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.
44

5-
<img src="https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-small.png" height="500" />
5+
<img src="https://raw.githubusercontent.com/SpikeHimself/XStorage/main/images/screenshot-v1.1.0-small.png" height="480" />
66

77

88
# Features
@@ -11,22 +11,17 @@ XStorage lets you open multiple chests at once, rename them, and move items/stac
1111

1212
By pressing alt-interact (`Shift + E` by default), you can give your chests a name. This name is shown when you hover over the chest, and also in the panel above the inventory when a chest is opened.
1313

14-
Chest names will be permanently stored in your world file. Uninstalling XStorage makes them go away, but after reinstalling they will be recovered.
15-
1614
#### Open many chests
1715

18-
To display multiple chests, XStorage creates a new panel in the UI. Sadly there aren't enough pixels on the screen to make everything fit nicely, so there is a small overlap with existing UI panels. Hopefully I can address this in the future.
19-
20-
In theory there is no limit to how many chests XStorage can display. When the UI panel is full, XStorage makes the panel scrollable. In a future version, I might impose a restriction on how many chests can be opened though, as this could cause performance issues.
16+
To display multiple chests, XStorage creates a new panel in the UI. The panel will automatically expand to fit in as many chests as it can. You can restrict the width and height in XStorage's config.
2117

22-
Also on the roadmap are config options that let you configure the distance and methods that decide which chests are opened. One such method I have in mind is chest linking, i.e. every opened chests searches for other chests near it, so that you could open an entire row of chests from either end. For now, XStorage opens any chest that is within 5 meters of the player (again, with no maximum amount of chests).
18+
When you open more chests than XStorage can display on the screen, this panel will become scrollable.
2319

2420
#### Moving items/stacks to the most suitable chest
2521

2622
When you auto-move an item from your inventory (via `Ctrl + Click`), XStorage tries to find the most suitable chest to put the item/stack in. It does so by picking the chest containing the highest quantity of the item you are moving, from all opened chests that still have free space.
27-
So if you have a wooden chest with 499 stone in it, and you `Ctrl + Click` on a stack of stone in your inventory, 1 stone will be moved to that chest. You have to then `Ctrl + Click` it again to make the rest go to the next most suitable chest.
2823

29-
`Ctrl + Click`-ing an item or stack in any of the chests will always make it go to the player inventory.
24+
`Ctrl + Click`-ing an item or stack in any of the chests will always make it go to the player inventory (equal to vanilla behaviour).
3025

3126
#### Multiplayer
3227

@@ -36,7 +31,6 @@ In multiplayer games, all players need to have XStorage installed, or it will no
3631

3732
There are a few things that, at this stage, XStorage does not do well, or at all:
3833
* **Gamepad input**: XStorage does not deal with gamepad input at all. That is to say, the UI kind of breaks when you use a gamepad. I will look into this in the future, but for now this mod is pretty much mouse/keyboard only.
39-
* **The panel does not fit**: The XStorage UI panel does not fit within the vanilla UI very well. I am considering alternative ways of displaying the container panels (for example by overlapping or even removing the crafting panel. Does anyone even use that while opening a chest?)
4034

4135

4236
XStorage looks best when playing at a 16:9 ratio with a UI scaling of 95% or smaller.
@@ -57,6 +51,27 @@ I very strongly recommend using a mod manager such as [Vortex](https://www.nexus
5751

5852
# Changelogs
5953

54+
* **v1.1.0** (2023-03-11)
55+
56+
* Fix error when placing a new chest
57+
58+
* Fix a HarmonyX warning that occurs when loading XStorage; this was caused by a library I use locally to manage documentation, but XStorage does not ship with this library.
59+
60+
* Fix being able to rename chests that are protected by a ward
61+
62+
* UI overhaul:
63+
64+
* You can now drag the XStorage panel
65+
66+
* You can set the maximum panel size in XStorage's config file using MaxColumns and MaxRows. Default value is 2 columns by 3 rows. XStorage will still restrict the size by what fits on your screen.
67+
68+
* XStorage will store the position of the panel per grid size when you close the panel, so that next time you open a panel of the same size, it will be restored to that position on the screen.
69+
70+
* Many code improvements and optimisations
71+
72+
<details>
73+
<summary>Click to view previous versions</summary>
74+
6075
* **v1.0.2** (2023-03-02)
6176

6277
* Fix tooltips not always being fully visible
@@ -65,9 +80,6 @@ I very strongly recommend using a mod manager such as [Vortex](https://www.nexus
6580

6681
* Reworked a large portion of the containers panel UI
6782

68-
<details>
69-
<summary>Click to view previous versions</summary>
70-
7183
* **v1.0.1** (2023-02-28)
7284

7385
* Remove "valheim.exe" check as it stops dedicated servers from loading the mod.

0 commit comments

Comments
 (0)