fixed chicken messages
[snoogans.git] / README
blobe152b8acbe6a0d9e8127bab4a1008cdef98298af
1 snoogans v 0.4 by gonzoj
4 Features:
5 ---------
7         - compatible with latest patch 1.13c
8         - reveals automap
9         - draws preset units onto automap (including frozen Anya, Izual etc.)
10         - places monsters and missiles onto automap (indicates immunities with 
11           intiutive colors)
12         - draws names over champion and boss monsters
13         - draws level names over exits (the correct Tal Rasha's tomb is colored 
14           green)
15         - adds IP address of the game server to the automap information
16         - puts the last game name into the create / join box
17         - enables the player to view other players' gear
18         - displays the iLvl of items, the number of sockets and if it's ethereal
20         
21 Requirements:
22 -------------
24 snoogans in its current version depends on various modules of wine (e.g. 
25 kernel32.dll.so), to be able to initialize correctly. If you're not running 
26 Diablo under wine, you cannot use snoogans at the moment. I don't consider this 
27 a major issue, because most of you will use wine anyway. Just wanted to make 
28 that clear.
30         
31 Installation:
32 -------------
34 snoogans can be build for two versions of Diablo, 1.12a and 1.13c (released
35 23.02.2010). To switch between the build process for the different versions 
36 (default: 1.13c), use the simple configure script that is contained in the 
37 release. If you'd like for instance to build snoogans for the 1.13c patch, 
38 run:
40 $ ./configure --version=1.13
42 After you configured the build process, just compile:
44 $ make
46 And finally install snoogans:
48 $ make install
50 Now you're good to go. Optionally, you can clean up after installation:
52 $ make clean
54 To uninstall snoogans, run:
56 $ make remove
58 NOTE: The default location for installation is /usr/local/lib. If you're 
59 dynamic loader can't find snoogans, consider to add this location to the 
60 loader's configuration or adjust the installpath in the Makefile.
63 Usage:
64 ------
66 To use snoogans, you have to inject snoogans.so into the running process. I've 
67 released an injector called surgeon, check the release thread at blizzhackers.cc
68 for more information. However, you're not limited to use surgeon, you can use 
69 whatever injector you prefer (there are some public available, although most of 
70 them are merely a proof of conecpt implementation). You could even use gdb for 
71 this purpose.
73 IMPORTANT: Inject snoogans AFTER you've created / joined a game. Injecting it 
74 previously will result in a not correctly initialized module, I may fix this 
75 issue in an upcoming version.
77 When snoogans has been loaded successfully, it will reveal the whole act 
78 everytime you toggle the automap, if not done so already. To view other 
79 players' gear select a player by hovering the mouse over its model and press 
80 your inventory hotkey.