HELP FILE


THE BASICS


StashNinja is an unofficial, fan-made stash editor for Torchlight 2.

Main Features: Features Planned for Future Versions (Not Currently Available): About Version 0.51beta: Change Log:

TABLE OF CONTENTS


INSTALLATION
USAGE
THE MENU
TORCHLIGHT 2 UPDATES
MOD COMPATIBILITY

INSTALLATION


Create a directory wherever you like. Extract the entire .7z archive to the directory. Make sure to extract everything from the archive. Also make sure to preserve the directory structure. Double-click TL2StashNinja.exe to run StashNinja.

If you want a shortcut, right-click TL2StashNinja.exe, and select "create shortcut," then cut/paste the shortcut to your desktop and/or start menu.


USAGE


Left Pane:
The left pane displays the items in your external infinite stash. Click on an item to select it.

You may alter or restrict the items that appear in the infinite stash pane in the following ways:

You may open and load a different infinite stash file on your computer by using the "Select Infinite Stash Dir" button. Note that this is a one-time change. If you want to permanently change the default location StashNinja looks for the infinite stash, use the Options Menu instead.

You may reload the infinite stash by clicking the "Reload Infinite Stash" button.
(Note that it is NOT advised to alter your infinite stash files via another program while StashNinja is runnning.)

Right Pane:
The right pane displays the items in your in-game shared stash. Click on an item to select it.

You may alter or restrict the items that appear in the shared stash pane in the following ways:

The "Free Spaces" display shows how many free spaces are available in each tab of your shared stash. Obviously, you cannot move or copy items to your shared stash if there is no space in corresponding tab.

You may open and load a different shared stash file on your computer by using the "Select TL2 Save Dir" button. Note that this is a one-time change. If you want to permanently change the default location StashNinja looks for the shared stash, use the Options Menu instead.

You may reload the shared stash by clicking the "Reload Shared Stash" button.
(Note that it is NOT advised to run TL2 and StashNinja at the same time. If you do so anyway, make sure to only use StashNinja while TL2 is on the home menu screen, and to reload the stash in StashNinja after playing any character in TL2.)

The "Program Status" monitor displays whether StashNinja is ready to accept your next command or still processing the previous one.

Center Pane:
The center pane displays information about the currently selected item. If no item is selected, a ninja is displayed.

If the currently selected item is in the shared stash, you may move it to the infinite stash by clicking the "Move item from shared stash to infinite stash" button (1st row, 1st column). Otherwise, the button will be disabled.
If the currently selected item is in the infinite stash, you may move it to the shared stash by clicking the "Move item from infinite stash to shared stash" button (1st row, 4th column). Otherwise, the button will be disabled.
If the currently selected item is in the shared stash, you may copy it to the infinite stash by clicking the "Copy item from shared stash to infinite stash" button (1st row, 2nd column). Otherwise, the button will be disabled.
If the currently selected item is in the infinite stash, you may copy it to the shared stash by clicking the "Copy item from infinite stash to shared stash" button (1st row, 3rd column). Otherwise, the button will be disabled.

You can copy or move items between the hardcore and softcore shared stashes by copying or moving the item to the infinite stash, changing the shared stash from hardcore to softcore (or vice versa), and then copying or moving the item from the infinite stash to the shared stash.

You may delete the currently selected item by clicking the "Delete item" button (2nd row, 3rd column). You will be asked to confirm before the item is deleted. Deletion is permanent.

You may remove the "CHEATED ITEM" flag from the currently selected item by clicking the "Remove 'CHEATED ITEM' flag from item" button (2nd row, 4th column). This button does nothing if the item is not flagged.

You may add sockets to an item by clicking the "Add socket to item" button (3rd row, 1st column). Each click adds one socket. If you try to add a socket to an item that already has two or more sockets, you will be asked for confirmation before a socket is added. You cannot give an item more than five sockets. You cannot add sockets to non-socketable items such as fish.

The disenchant feature (3rd row, 2nd column) doesn't do anything in this beta version. Disenchanting is planned for a future version.

The enchant feature (3rd row, 3rd column) doesn't do anything in this beta version. Enchanting is planned for a future version.

The item editing feature (3rd row, 4th column) doesn't do anything in this beta version. Item editing is planned for a future version.



File
Options
Launches the options menu.

The options menu will also launch automatically the first time you run StashNinja.

Trade Wizard
Doesn't do anything in this beta version. The trade wizard is planned for a future version.

Help


TORCHLIGHT 2 UPDATES


In order to properly display item information, StashNinja uses an unpacked copy of Torchlight 2's item data files. If an update to Torchlight 2 adds items or changes existing items, this will not be reflected in StashNinja's data files. Thus the displays for the new/changed items will be wrong. You will still be able to move/copy these files even though their displays are wrong.

The next update to StashNinja will include updated data files.

If you cannot wait for the next update of StashNinja, then you can update the data files yourself by following the procedure for item mods described below.


MOD COMPATIBILITY


For purposes of compatibility with StashNinja, mods can be divided into three categories:
  1. Mods that alter the shared stash. StashNinja is compatible with SOME increased-stash-size mods, but ONLY if you follow the instructions below. StashNinja is simply incompatible with other mods that alter the shared stash. You will probably get bizarre, buggy behavior if you try to use StashNinja on a stash that's been modified by one of these mods. Remove the mod before using StashNinja.
  2. Mods that add or change items. StashNinja is pretty broadly compatible with items from these mods. See below for the procedure to make these items display properly.
  3. Mods that do neither of the above. StashNinja is completely agnostic to such mods. You do not have to worry about compatibility issues for these mods.
Procedure for Making StashNinja Compatible with Increased-Stash-Size Mods
Edit the file <StashNinja Directory>\GameData\MaxStashSize.txt by changing the first line as follows: If the mod has just the three basic tabs, the value should be equal to the number of spaces in one tab. If the mod has multiple tabs for each item type, the value should be equal to the total number of spaces for each item type. There is no way to make StashNinja compatible with mods that add new tab types (e.g. a "socketables tab"). Not all mods with multiple tabs for each item type are compatible with StashNinja. (Mod developers: If you want your mod to be compatible with StashNinja, you must use continuous indexing across all tabs that share an item type.)

Procedure for Making StashNinja Compatible with Modded Items
(If you are using a mod made by someone else and you do not understand the following, then ask the person who made the mod to help.)