Skip to content

Commit

Permalink
make readme less copy/pasta
Browse files Browse the repository at this point in the history
  • Loading branch information
mralbobo committed Apr 1, 2016
1 parent 8782dbf commit 531c15b
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 27 deletions.
15 changes: 0 additions & 15 deletions ChestPooling/GateOpenerMain.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,6 @@
using Newtonsoft.Json;
using System.IO;


//bugs while playing:
/*
- adding an item to a chest that already has a partial in the open chest and in the remote chest, might duplicate.
Need to add a pre-check for the open chest to give it priority. * probably fixed, nope, seems that the isn't full check broke being able to remote add when
theres a full stack
- weirdness when item exists in multiple places, possibly only when stacks are mostly full
- need to come up with a system to properly identify if an item should stay in it's current chest
if the item matched in the chest is literally the same item, then it should start the move check
if it's not, abort
*/

namespace GateOpener
{
public class GateOpenerMainClass : Mod
Expand All @@ -38,7 +24,6 @@ static void myLog(String theString) {
#if DEBUG
Log.Info(theString);
#endif

}

static Dictionary<Vector2, StardewValley.Fence> openGates = new Dictionary<Vector2, Fence>();
Expand Down
13 changes: 1 addition & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
## What is it
Mod for stardew valley, built with SMAPI 0.39.2.
Basically what it does it provide a means of pooling all of your individual chests together when depositing. So for example you can return from mining, walk up to a single chest, throw in everything. The mod will then for example move the minerals to the mineral chest, the ore and bars to their chest, the food items to the food chest, etc. It essentially keys off of where your existing items are and adds additional items to existing stacks. It should also be noted that the mod will not take effect when moving less then a full stack (right click), this allows you to effectively override the mods auto-sorting at will.

## I want more detail
Breaking this up into steps:
* item added to chest, if there's an existing stack or the item does not exist in another chest (or all the other stacks are full), it's added normally.
* if the item exists in another chest and there's room for it, it gets moved to the other chest
* if there's only partial room the stack gets split and whatever overflows stays in the current chest
Opens gates when you get near them, closes them when you move away.

## Installation
* install SMAPI http://community.playstarbound.com/threads/stardew-modding-api-0-39-2.108375/
* download https://github.com/mralbobo/stardew-chest-pooling/releases
* place in mods folder

## Known bugs
* doesn't work on chests inside constructed buildings, barn, coop, etc. Can probably fix this, need motivation.
* fridge doesn't connect, not a bug strictly speaking but it's something I want.
* not terribly fond of the behavior when a stack is filled in the currently open chest. But I'm fairly sure I need either a "chestUpdated" or "beforeInventoryChanged" event to fix it consistently.

## Building it
* Presumably you should just be able to clone and run this... Open an issue if it doesn't work for some reason.

0 comments on commit 531c15b

Please sign in to comment.