1. Introduction
  2. Warcraft III Screenshot Reader
  3. How to use it
    1. Saving
    2. Loading
  4. Adding the save system to your map
  5. System requirements
  6. Licence
  7. Files
  8. Contact
  9. History

Last update: 05-01-2008

Notice

I have released the program under the GPL. It is now open-source and the project's page has moved to sourceforge. Please use that page for the latest releases.

Introduction

This page is about a WarcraftScreenshotReader, a program that decodes save codes from Warcraft III screenshots.

Most Warcraft III RPG-style maps have some kind of "save" command that allows the player to save his character, inventory, etc. This is usually implemented by displaying a code that the player has to write down. The next time the map is played, the player types the code and his character is restored. While this works well, the process of writing down the code is annoying and error-prone.

Example of a typical save code

Warcraft III Screenshot Reader

WarcraftScreenshotReader simplifies this task by parsing a screenshot that contains a specially formatted code and decoding the text that is embedded in it.

Example of an encoded save code

How to use it

Saving

  1. Start the program and check the Options / Monitor Clipboard menu item.
  2. When you want to save, type the map's save command, which is usually -save, but this depends on the map. Check the map's instructions.
  3. A color-coded code will appear. Press Prnt Scrn to take a screenshot.
  4. The code will be saved to a text file.
  5. By default, the program writes to C:\Program Files\Warcraft III\Screenshots\codes.txt. That can be changed with the Options / Set Save Codes Path... menu item.

Loading

  1. Click the Options / Open Saves Code File menu item to open the save codes file. Locate the desired save code and copy it to the clipboard.
  2. Start the game.
  3. Type the map's load command, which is usually -load, then press Ctrl+V to paste the code and press Enter.

If you do not want to use the 'Monitor Clipboard' option, you can also open a screenshot with the File / Open Screenshot... menu item. The code will be decoded and copied to the clipboard.

Adding the save system to your map

Before using this system, your map should already have a traditional load/save system. I can't help you on that part but there are lots of tutorials for that. You should provide two save commands, one for people that do not want to use this system, and the one that that displays the color-coded code.

The JASS code provided contains three functions that you should include on your save code. The EncodeString function takes the regular save code as input and returns the color-coded equivalent.

Previous versions of the program required that the code was displayed as cinematics transmission. Since the program now detects automaticallt the location of the save code, this is no longer required.

The function accepts only the following characters: digits (0-9), letters (a-z and A-Z), dash (-) and space ( ). It will not work correctly with any other characters.

System requirements

This program requires the .NET Framework 2.0 or later. It is installed automatically by the setup program. If you download the no-install version, you need to install if manually. If you use Windows Vista, you already have it. Otherwise, try to run the program. If you get an error, download and install the .NET Framework.

Licence

This program is distributed under the GPL version 3.

Files

Contact

Fell free to contact me if you have any question, if you find a bug, or for any other reason. If you use this system in a map, I will be pleased if you let me know.

History

05-01-2008

23-12-2007

27-11-2007

22-11-2007

19-11-2007