diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -2,4 +2,5 @@ syntax: glob obj/ *.userprefs *.orig -*.swp \ No newline at end of file +*.swp +*.zip \ No newline at end of file diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,23 +1,58 @@ # Desert Paint Lab This is a tool for players to record their [Pigment Laboratory](http://www.atitd.org/wiki/tale6/Pigment_Laboratory) -ingredient reactions in [A Tale in the Desert](http://www.atitd.com/). You can maintain multiple persistent player -profiles, each with their own reaction history. +ingredient reactions in [A Tale in the Desert](http://www.atitd.com/). + +### Features + +* Easily scans your screen for the paint bench reaction values, without any math, measuring, or manual number entry. +* Warns you when a reaction clipped below 0. +* Supports multiple character profiles. +* Can export to [PracticalPaint](http://www.atitd.org/wiki/tale6/File:PracticalPaint.zip) data format. +* Includes simulator for experimenting with recipes without spending ingredients. + +## Tale 7 -Once you are done gathering all of your reactions, you can use the built-in simulator to figure out what your paint combinations -will do (`Window > Run Simulator`), or you can export a file to use with the -[PracticalPaint](http://www.atitd.org/wiki/tale6/File:PracticalPaint.zip) recipe finder. +This application has been updated for Tale 7. The current version is a **RELEASE CANDIDATE**. It may be buggy. +If you find any problems with it, please [open an issue](https://bitbucket.org/Malkyne/desert-paint-lab/issues) or /chat Afrah +in the game. + +## Directions + +### Download Desert Paint Lab + +You can always find the available downloads, on [the download page](https://bitbucket.org/Malkyne/desert-paint-lab/downloads). + +The most recent version is [T7 Release Candidate 1](https://bitbucket.org/Malkyne/desert-paint-lab/downloads/DesertPaintLab_T7_RC1.zip). This application should run under Mono on Mac, Linux, and Windows. If you are on Windows, and do not have Mono installed, you can install [GTK# for .NET](http://www.mono-project.com/download/#download-win), without the need for installing Mono. -# Tale 7 +### Set Up a Profile + +The first time you run Desert Paint Lab, it will prompt you to make a profile. You may either create a new profile, or import an existing PracticalPaint reactions.txt file. + +### Start Testing! + +Add two ingredients to your paint bench. Select those same ingredients in Desert Paint Lab. Then, with the Pigment Lab dialog unobstructred, select the **Capture** button. Once you are satisfied with the result, click the **Record** button. The data will automatically be added to your profile. + +### Clipped? Huh? + +Occasionally, you will see a warning dialog that informs you that a "Reaction clipped." That means that one or more of the color components dropped to zero or below. This makes it impossible to calculate the reaction from these two ingredients. -This application _has not yet been tested_ for Tale 7. However, I intend to give it a thorough testing, -once I get a Pigment Lab up. If you find any problems with it, before I get a chance to verify it, please [open an issue](https://bitbucket.org/Malkyne/desert-paint-lab/issues). Once I can verify that it is working properly, I will post -executables and an illustrated guide, for public consumption. +You can solve this by doing a three-way test. To do this, select a third ingredient that has known reaction values with the two ingredients you are attempting to pair. Combine that with your two ingredients. In Desert Paint Lab, you'll want to select a known pairing in the first two boxes, and the other ingredient in the third. Desert Paint Lab can then do all the math to figure out the mystery reaction. + +### Finishing Up + +When you're done testing your reactions, you can either use the built-in Pigment Lab simulator (`Window > Run Simulator`) to experiment with recipes, without dipping into your precious ingredient stocks. Alternatively, you can export your reactions in PracticalPaint format. -# For Developers +## Known Issues + +### Slowness + +If you are running on a multi-screen system, or a very high-resolution screen, you may find that Desert Paint Lab is rather slow in determining paint reactions. That's because you have a lot of screen real-estate to scan, to look for the Pigment Lab dialog. You can speed up the scanning process by ensuring that your Pigment Lab Dialog is as far to the upper-left of the screen as possible. + +## For Developers This application was developed using [MonoDevelop](http://www.monodevelop.com/), using the [Stetic GTK UI designer](http://www.monodevelop.com/documentation/stetic-gui-designer/). \ No newline at end of file