			PenguinPlug README


PenguinPlug is a multifunction pluggin for starcraft. It aims at
providing extra functions, the following are currently implemented :

- RWT : Replay With text. when you save a replay, all the message you recived
	from players (and your own messages) will be recorded in the replay.
	when you watch them, they appear. it works more or less like RWA
	(replay with audio by JCA), except you dont need a microphone: the poor
	man version :) and you can record some funny comment from your opponents
	it should give a new life to some replays.
	note : the player that is saving the replay must have it running durring
	all the game, and each player that is watching it must have itrunning if
	they want to view the comments. If they dont have PenguinPlug, it will
	still be played like a normal replay for them.

- unshifted hotkey : if you have a french azerty keyboard, then you must use
	the "shift key" to type number, and it's VERY annoying for hotkeys.
	this pluggin allow you to use hotkey without using shift or capslock.


Requirement :
- Windows XP/NT/2000. this program does NOT work with windows 95 or 98.
if you want a version for 95, do it yourself :) modify the loader, send
me your changes and if it works well, i will integrate it.
- Broodwar (probably work with plain SC too but not tested)

Program usage : copy loaddll.exe and penguinplug.spl to your starcraft
directory (the one you have starcraft.exe in). 
Start starcraft first, then, run loaddll, it's a text based program,
if you want to see if it works, you have to run it in a command line
("start menu -> run -> type 'cmd' -> press ok -> type
'cd "c:\your\starcraft\directory"' then return -> type loaddll.exe).
if you see "Loading "penguinplug.spl": Loaded (0x0...0000)" then it's
a good sign that it is probably working. At the game start you see a
message.


Classic disclaimers: This program is a 3rd party program, that is not
approved by Blizzard. Be aware that by running it you may break the ELUA.
However, it's NOT a cheat program, and it doesnt give any unfair gameplay
advantage, i will never put any features that could be considered as
"cheating".

Security concerns: As long as you download the program directly from me, it
has no trojan or virus included :) This version dont do anything that is about
network. It doesnt manipulate to your files, except the replays when you save
and open them, and the file penguinplug-debug.txt. It doesnt affect any other
program except if they are named starcraft.exe. It stay in memory as long as
starcraft is running, and stop when you stop it.
However, i cant provide any "bugfree warranty", it's still a beta version, so
it can probably crash, corrupt the replays you are saving with it, prevent
you to load some others, and have whatever nasty unintended behavior. But
I tested it and it seems to work quite well for me, if you notice some bugs,
please warn me with the exact explainations and i will do my best to fix
them in a future version. about security, read the next part. You are not
forced to trust me if i say "it is a very nice program it wont hurt your
computer :)". If you have some programming knowledge, use it, the source
code is here, you can recomplie it, check what it do to your comp, debug it,
send me patchs or new functions...

Source code: i provide the source code. It's not perfect, not very well
commented, not extremely readable. But it's here, everything i programmed
you have it here. You can use it as you want, as long as you dont derivate it
into a cheat program (that would not be the best codebase for your intention
in this case i belive anyway). You have to say where it come from also,
you cant just change "superpenguin" to "your name" in the files, and say
"it's me, i did it alone" :)

extra credits: Probably half of the code lines come from someone else, i dont
have time to re-invent the wheel :)
- DLL Injection and function interception tutorial By CrankHank 
	http://www.codeproject.com/dll/DLL_Injection_tutorial.asp
- SC BaseHook 1.1 - by Palomino
- How To Enumerate Applications Using Win32 APIs
	http://support.microsoft.com/default.aspx?scid=kb;en-us;Q175030

special thanx :
all my friends & my cousins on battle.net
JCA and Lasgo for making usefull and fair 3rd party programs

if you have some ideas / comments / questions, feel free to ask me by
email sart@host.sk, or i also spend some time in http://www.starcraftdream.com
forums.

webpage : i will put a webpage, http://ste.gnux.info/pp in the future, it
will be the safe place to download the last updated version.

history :
v0.1 - 20/11/2004 first "usable version", RWT + hotkeyfr


superpenguin

