search

Kyromyr / D2Stats

59 stars 33 forks source link

Notifier help documentation #10

Open ghost opened 4 years ago

ghost commented 4 years ago

Is there anyone with in-depth knowledge about the notifier and its capabilities? If so I'd like to write a proper documentation for the help window as the current one is lackluster to put it mildly.

antarek commented 3 years ago

D2Stats is really a wonderful tool but i have to agree with Myrthian request.

The notifier part of D2Stats needs a documentation containing the full list of available tags. Otherwise people won't be able to use it properly for as far as many tags are missing from those listed in the Help panel.

Also adding a link to any regex documentation should help people not familiar with coding using this language.

Kyromyr commented 3 years ago

When I first wrote the help window I made the decision to only include information deemed necessary, to reduce the wall of text, and let the community provide assistance where necessary. Part of that meant not including certain tags because there was simply no reason to. In retrospect a regex doc link could've been included, and my reasoning for not doing so might've been "google it". For the tag explanations, keep in mind the last time I played was the patch before Sigma. I do not know the current state of the game, or if the logic still holds up.

Low-quality, normal, superior and magic items were interchangeable due to cube recipes. Normal and superior were included to complement the eth tag, since those items could not be cubed, but low and magic had no reason to be listed. Honorific and crafted items could only be created with the cube, so those tags had no reason to exist other than for completeness sake. Sockets could be punched in unsocketed items. I don't remember why I implemented the socket tag. Maybe eth, again, but I think that recipe did work for eth items. Several colors were deemed unreadable, hence their exclusion, and finally the show tag was excluded under the rationale that anything you specifically want to show you probably want a notification for anyway.