18
GoMule User Guide. Silospen August 7, 2009 1

GoMule User Guide. - Mirror Servicesourceforge.mirrorservice.org/g/go/gomule/gomule/R0.31/GoMuleDocs.pdf · GoMule User Guide. Silospen August 7 ... 1 Introduction 4 1.1 File Types

  • Upload
    dangque

  • View
    212

  • Download
    0

Embed Size (px)

Citation preview

GoMule User Guide.

Silospen

August 7, 2009

1

Contents

1 Introduction 41.1 File Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.1.1 D2S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1.2 D2X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1.3 ORG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.2 Project Based Muling . . . . . . . . . . . . . . . . . . . . . . . . 41.2.1 Example Setup . . . . . . . . . . . . . . . . . . . . . . . . 51.2.2 Example Project Layout . . . . . . . . . . . . . . . . . . . 5

2 Obtaining and Installing GoMule 62.1 Obtaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3 Normal GoMule Operation 6

4 GoMule Tool/Menu Bar 74.1 Character (D2S) Operations . . . . . . . . . . . . . . . . . . . . . 7

4.1.1 Open Char . . . . . . . . . . . . . . . . . . . . . . . . . . 74.1.2 Add Char . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4.2 Stash (D2X) Operations . . . . . . . . . . . . . . . . . . . . . . . 74.2.1 New Stash . . . . . . . . . . . . . . . . . . . . . . . . . . . 74.2.2 Open Stash . . . . . . . . . . . . . . . . . . . . . . . . . . 74.2.3 Add Stash . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4.3 Save All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74.4 Reload All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84.5 File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84.6 Project Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.6.1 Project Preferences . . . . . . . . . . . . . . . . . . . . . . 84.7 About Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5 GoMule Left Pane 9

6 Project Selector Box 96.1 Char/Stash View . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

6.1.1 All Item View . . . . . . . . . . . . . . . . . . . . . . . . . 96.2 Project Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

6.2.1 Proj Flavie Report . . . . . . . . . . . . . . . . . . . . . . 106.2.2 Proj Txt Dump . . . . . . . . . . . . . . . . . . . . . . . . 10

7 GoMule Right Pane 117.1 Item Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7.1.1 GoMule Bank . . . . . . . . . . . . . . . . . . . . . . . . . 127.1.2 Item View Panel . . . . . . . . . . . . . . . . . . . . . . . 12

7.2 Item Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127.2.1 Pick All . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127.2.2 Drop All . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127.2.3 Pickup From . . . . . . . . . . . . . . . . . . . . . . . . . 127.2.4 Drop From . . . . . . . . . . . . . . . . . . . . . . . . . . 12

7.3 Output Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2

8 Muling with Characters 138.1 Character Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

8.1.1 Right Click Menu . . . . . . . . . . . . . . . . . . . . . . . 138.1.2 Delete? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.1.3 View Item . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

8.2 Stats Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.3 Quest Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.4 Corpse Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.5 Mercenary Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.6 Bank Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.7 Dump Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.8 Messages Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148.9 AutoSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

9 Muling with Stashes 159.1 Item Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159.2 View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169.3 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169.4 Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

9.4.1 Pickup Button . . . . . . . . . . . . . . . . . . . . . . . . 169.4.2 Drop Button . . . . . . . . . . . . . . . . . . . . . . . . . 169.4.3 Delete Button . . . . . . . . . . . . . . . . . . . . . . . . . 169.4.4 Delete Dupes Button . . . . . . . . . . . . . . . . . . . . . 169.4.5 Filter... Button . . . . . . . . . . . . . . . . . . . . . . . . 169.4.6 Filtering non numerical stats . . . . . . . . . . . . . . . . 17

10 Known Issues 1810.1 None so far... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

11 That’s it. 18

3

1 Introduction

GoMule is designed as a muling application. Muling is the movement of itemsfrom one character to another, either in Diablo 2 or outside of the game. In thiscase, GoMule allows character items to be moved between characters withoutthe Diablo 2 application.

1.1 File Types

There are 3 basic file types:

• D2S: Standard Diablo 2 character file

• D2X: ATMA Diablo 2 stash

• ORG: ATMA Diablo 2 character file backup

1.1.1 D2S

The D2S file is the format created by blizzard which holds the Diablo 2 characterinformation. This ranges from current stat and skill allocation, to quest dataand item information. GoMule reads from and edits these files, resulting intransferral of items and displaying of character details.

1.1.2 D2X

The Diablo 2 character has only a small amount of space to store items. Thus,a more appropriate way of storing items was devised by the creator of ATMA,resulting in the D2X file. This is commonly called a “stash”. You can think ofa D2X as an unlimited extended stash for items, giving you the ability to storea much larger number of items.

1.1.3 ORG

ORG files are copies made at regular intervals to ensure that any data whichis lost can be restored. There should be a .ORG file for every .D2S file andrestoring them simply involves renaming the files from .ORG to .D2S.

1.2 Project Based Muling

GoMule uses a system called ’projects’ to make it easier for the user to organisetheir characters and stashes. It also allows a complete separation of differentitems and characters, such as HC vs SC, twinked vs untwinked etc.

If you do not wish to use projects, you don’t have to do anything. Thedefault project, ’GoMule’, will be used by default and you don’t have to worryabout changing projects or anything along those lines. If you’re an intrigueduser, however, you should at least try out projects, especially if you have avariety of Diablo 2 projects going on!

4

1.2.1 Example Setup

So, lets say you have a number of Diablo 2 projects going on, such as:

• PVP Project

• MF’ing various bosses

• Untwinked HC singlepass tournament

And lets imagine you have stashes such as:

• Large unique item stash

• Large set item stash

• Large misc item stash

• Collection of PVP characters

• Collection of MF characters

• Single stash for finds in the HC tourney

• Single character from HC tourney

1.2.2 Example Project Layout

I would setup my projects like this:

“MF” Project, containing:

• Large unique item stash

• Large set item stash

• Large misc item stash

• Collection of MF characters

“PVP” Project, containing:

• Large unique item stash

• Large set item stash

• Large misc item stash

• Collection of PVP characters

“HCTourney” Project, containing:

• Single stash for finds in the HC tourney

• Single character from HC tourney

This solution may not be the best for you, but it allows you to isolate youritems, characters and stashes, so you only have to consider a small number ata time. With the case of the tournament project in this example, it is totallyisolated from all of your other chars/stashes/items, so there is no chance of anaccidental item crossing into the tournament stash.

Anyway, have a look at it. You can always not use it if you want.

5

2 Obtaining and Installing GoMule

2.1 Obtaining

If you have found this guide, you should also have found a link to GoMule

2.2 Installation

GoMule requires java. If GoMule doesn’t work it is likely you need to downloadjava from sun.java.com

Download the latest.zip folder and extract it. Inside there should be a num-ber of folders and a file named “GoMule.jar”. Double click on this folder. Forthe command line monkeys, run “java -jar GoMule.jar”.

3 Normal GoMule Operation

This is the screen which you should see when running GoMule:

Welcome to the main GUI. It is split into 3 separate areas which have beenlabeled and will be examined in depth:

• GoMule Tool/Menu Bar

• GoMule Left Pane

• GoMule Right Pane

6

4 GoMule Tool/Menu Bar

4.1 Character (D2S) Operations

4.1.1 Open Char

This allows a character to be opened in GoMule. Once a character has beenopened, it is then accessible through the char/stash view. Multiple characterscan be selected in the open file window, using standard shift + click, ctrl + clickand ctrl + A methods.

4.1.2 Add Char

This adds a character to the GoMule char/stash view without opening thecharacter up. Again, multiple files can be selected. This function is useful whenyou wish to add a large number of characters to GoMule’s char/stash view, butdon’t wish to open them all.

4.2 Stash (D2X) Operations

4.2.1 New Stash

Creates a new, empty item stash and adds it to the char/stash view.

4.2.2 Open Stash

Same as “Add Char”, but with stashes.

4.2.3 Add Stash

Same as “Add Char”, but with stashes.

4.3 Save All

Saves all of the currently open stashes/chars.

7

4.4 Reload All

Reloads all the currently open stashes/chars.

4.5 File Menu

This actually just contains what’s already on the toolbar. It just looks odd if aprogram doesn’t have one ;)

4.6 Project Menu

Contains the project preferences box.

4.6.1 Project Preferences

The project options are mainly self explanatory, apart from “Ignore com-mon items on pickup”. When using multiple pickup buttons, certain items areignored. These include:

• In the inventory: Cube, Tomes, Keys, Charms

• In the stash: Cube

• All equipped items

• All items on the belt

8

4.7 About Menu

Some thank-you’s and credits.

5 GoMule Left Pane

The left pane of GoMule is concerned with project control.

6 Project Selector Box

Using this dropdown box you can select any projects which you have added. Thedefault project is GoMule. Please see the projects section for more informationon projects.

6.1 Char/Stash View

This is a fast access panel to all of the characters and stashes which you haveopened with GoMule. When you open a character or a stash, it is automaticallyadded here. Then to open it again, simply double click on it here.

6.1.1 All Item View

The GoMule all item view is intended to allow a user to easily find items. WhenAll is clicked on, all of the chars/stashes in the current project (shown in the

9

Char/Stash view) are read and all of the items are placed into a stash. Thisstash is then displayed.

The stash cannot be added to, but items can be taken from it. If an itemis taken from the all item stash, it is taken from it’s location on whicheverchar/stash it exists in and placed on the clipboard.

6.2 Project Controls

The controls are fairly self explanatory. This is where you add, delete andclear all the chars/stashes from a GoMule project. Note that deleting a projectDELETES THE CLIPBOARD TOO!

6.2.1 Proj Flavie Report

This creates a flavie report of the entire project in the GoMule directory. Thename will look like 〈projname〉Report.html.

6.2.2 Proj Txt Dump

This performs a txt dump for every char/stash in the project. The dumps willbe saved to a folder in your GoMule directory named 〈projname〉Dumps.

10

7 GoMule Right Pane

The right pane of GoMule is concerned with item and character control.

7.1 Item Clipboard

The GoMule item clipboard is a location for items in transit. Items to bemoved are picked up onto the clipboard then taken off the clipboard when theyare dropped. Acts the same as the cursor in Diablo 2, but it allows multipleitems to be added to it. It operates on a Last In First Out (LIFO) principle, sothe next item you drop will be the last item you placed on the clipboard.

To drop an item further up the clipboard, click the name of the item to dropand then that item will be dropped on the next drop operation.

11

7.1.1 GoMule Bank

The GoMule bank is an unlimited store for gold. Simply place gold from youchars to here to store gold, through the bank interface on the character screens.

7.1.2 Item View Panel

This shows an image of the currently selected item in the clipboard. Hover overthe item and a popup of the item properties will appear. This allows you tocheck an item without removing it from the clipboard.

7.2 Item Control

These buttons allow you to quickly manipulate items. Note that if the “Ignorecommon items on pickup” box is checked in the project options, certain itemswill be ignored when using these buttons (see above).

7.2.1 Pick All

This is active for both stashes and characters. When you click it, all the itemscontained in the stash/character will be picked up and placed on the clipboard.

7.2.2 Drop All

This is active for both stashes and characters. When you click it, all the itemson the clipboard will be placed in the selected character/stash. In the case of acharacter, all the items that fit will be placed on the character.

7.2.3 Pickup From

This is active for only characters. Select from the dropdown box which area youwant to pick items up from. Click ’Pickup From...’ and all the items in thatarea will be put on the clipboard.

7.2.4 Drop From

This is active for only characters. Select from the dropdown box which areayou want to drop items to. Click ’Drop To...’ and items will be transferred tothe character from the clipboard to that area. If there are too many items, allthe items that will fit will be transferred.

7.3 Output Control

This is where you can output your character as a flavie report or txt dump.Buttons do what they say. Flavie dumps are saved as 〈charname〉Report.html.Text dumps are saved as 〈chardirectory/charname〉.txt.

12

8 Muling with Characters

This is what a character window looks like in GoMule:

The character is accessible through a number of tabs, which will now beexplained.

8.1 Character Tab

This is your basic item view of your character’s inventory, stash, cube and belt.You should recognise it.

To view the properties of an item, hover over an item and a tooltip with theproperties in it will appear.

To move an item, left click on the item. It will now be added to the clipboard.To place it down again, find a suitable location and left click to drop it. Noticehow the cursor changes when you are in a valid drop location.

To access weapon switch, click the “I” “II”, just as in game.

8.1.1 Right Click Menu

Right clicking on an item will bring up a new menu, containing the options:

• Delete?

• View Item

13

8.1.2 Delete?

Removes the item. This is permanent once the character file is saved, so usewisely on items you really do want to delete.

8.1.3 View Item

Opens a new window with the item dump in it, in the form of a text dump.This can be selected using the mouse or with ctrl + A, and copied with ctrl +C, allowing a user to show the properties of the item easily, once the dump ispasted somewhere else.

8.2 Stats Tab

Shows the current stats of your character as derived by GoMule. Also showsskill point allocations.

8.3 Quest Tab

The current quest and waypoint progression of your character.

8.4 Corpse Tab

Any items which are on your corpse or on the Diablo 2 cursor are shown here.They are not movable, you’ll have to do that in game.

8.5 Mercenary Tab

Shows your mercenary with some basic stats. You can give your mercenaryitems in the normal manner.

8.6 Bank Tab

Simple bank interface. You can transfer gold to your char from the clipboard orfrom your char to the clipboard. “Gold” is the gold on the Diablo 2 characterinventory screen, “Gold Stash” is the gold on the Diablo 2 stash screen.

8.7 Dump Tab

Basic text dump of all character information. Copy and paste it if you wish.

8.8 Messages Tab

Some tech stuff. This is what you’ll see when things go wrong.

8.9 AutoSave

Autosave is on, when you close a character using the “X”, it will be automaticallysaved.

14

9 Muling with Stashes

This is what a stash window looks like in GoMule:

Various buttons and filters will be explained later. There are 2 main panes:

• Item Pane

• View Pane

9.1 Item Pane

The item pane is a list of all the items in the stash currently. Clicking on anitem will show it’s details in the view pane. You can select multiple items usingctrl + click, shift + click or even clicking and dragging your mouse up/downthe list. ctrl + A works as well.

You can now pickup an item by double clicking on the name!

15

Items can be sorted by item name by clicking on the “Name” column header,level by clicking on the “lvl” column header, etc.

9.2 View Pane

Shows the dump of the item information.

9.3 Filters

There are various checkboxes and radiobuttons to filter the items in the itempane to allow you to find what you’re looking for. This should be self explana-tory, play with it a little and you’ll get the idea.

The “MaxLvl”, “MaxDex” and “MaxStr” fields allow you to filter based onthese fields. Just enter a number and the items will be filtered.

9.4 Buttons

9.4.1 Pickup Button

Takes the item currently selected in the item pane and moves it to the clipboard.

9.4.2 Drop Button

Drops the selected item on the clipboard or the last item added to the clipboardinto the stash.

9.4.3 Delete Button

Deletes the item currently selected in the item pane.

9.4.4 Delete Dupes Button

Deletes all items with dual fingerprints.

9.4.5 Filter... Button

Opens the custom filter window. The filter looks for items with a user specifiedproperty.

There are 3 parts to the custom filter, a String, a Value and Min/Max.The filter string has to match an item property. For instance, an item with

“20% Enhanced Damage” will be returned when the filter string “Enhanceddamage” is entered. This is also true for partial matches, “Damage”, “en-hanced”, “en”, “dam” will all return lists containing items with the Enhanceddamage property. The string is case insensitive.

The value is the particular value you’re looking for. This ties in with themin/max selection. For instance, “min” and “20” with the previous filter stringwill return all items in the stash with 20 or greater enhanced damage. “max”and “20” will return all items in the stash with 20 or less enhanced damage.

The buttons are simple, “Ok” performs the filtering, “Clear” removes thecurrent filter and “Cancel” dismisses the filter window.

Let me be a little more specific about the string search. You may be fa-miliar with a standard text string search in the form of the “find” function in

16

firefox/IE/Opera/whatever. Whatever you enter in the find box it will searchfor, but it can only have an exact match of all of the text entered as the searchstring. This is the same. “MF” will not find items with “Better Chance ofGetting Magic Items”, as it is displayed as “Better Chance of Getting MagicItems”. “Better”, “getting magic”, “magic items” all of these and any othercombination where the string order is preserved will work. Here’s a table:

What you’re looking for What you should enter (case does NOT matter)Magic find Better Chance of Getting Magic ItemsED enhanced damageMF Better Chance of Getting Magic Itemscold res Cold Resistias Increased attack speed

The table outlines the maximum you should enter as the search query.“cold res” is a partial of “cold resist” and so it will return all items with “coldresist” as a stat. “increased attack” will return items with IAS as it is a partialmatch on “increased attack speed”. “Increased speed” will not provide a match,because although it is a partial string of “increased attack speed”, the order hasbeen lost!

9.4.6 Filtering non numerical stats

There is also the possibility of looking for non numerical stats. If we look at theitem Fortitude:

FortitudeSuperior Archon PlateDefense: 1515IndestructibleRequired Level: 63Required Strength: 103Fingerprint: 0x291b495eItem Level: 90Version: ExpansionProperties:All Resistances +30200% Enhanced Defense

Then we can search for all of the following. Here’s another table (assumes“min” is selected:

What you’re looking for String Value (case does NOT matter)Fortitude Fortitude (nothing!)Ilvl Item Level (any num less than 91)Fingerprint: 0x291b495e 0x291b495e (nothing!)Version: Expansion Expansion (nothing!)

17

Get it? So if you’re looking for something without a specific integer value,just clear the value box. Internally this sets it to -1337, so placing -1337 as thevalue will have the same effect.

For stats such as poision damage over time, where there is more than onenumber, GoMule will always filter based on the first number in the property.“20% Chance to cast level 15 Chilling Armor when struck” will be performingthe val search on the “20%” and ignoring the “15”.

Again, this is still the maximum you should enter as the search query. “emlev”, “item l”, “m level” will all return the “item level”. “print”, “finger” willstill return fingerprint, “fort” will get “fortitude”. It doesn’t have to be thewhole thing, only a partial string.

I hope that helps you understand :) There should be a box to select statsfrom. But I’m too lazy to code it, as you’ve already been informed by GoMuleitself.

10 Known Issues

As GoMule is an open source project, it is entirely tested and improved by itsuser base. As such, there are a few issues that are currently affecting GoMule.

10.1 None so far...

As this is a new release of the beta, I am not currently aware of any seriousissues.

11 That’s it.

I hope you enjoy GoMule. Feel free to send feedback to [email protected]

18