Add a little Wiki

[Serverfrog]

Add a little Wiki for new user to understand some things that are not obvious. Like the Color of items, or classes and their differences or Keys to control (Like Space for pause).

[seiyria]

Well, item color is randomized (except in the case of corpses, where it takes from the monster color), and the various keys that do things are all developer controls. This is a good idea but to transfer all of this into a wiki will take entirely too much time because there's a lot of content.

[Serverfrog]

From the given Folder only the last 5 are interesting in the following order:

1. professions
2. races
3. traits
4. items
5. monsters

And for the start some clarifications, like that Item color is randomized and have no effect/monster-color.
And the the issue was to create a little wiki. Start early and start small ;) the more content is added, the more is needed to documented. Also: it has a Benefit as nice readable Documentation.

When i have the Time, i will help you by this

Also: is the Coloring not like this? https://github.com/seiyria/Roguathia/blob/master/src/js/rogue/constants/glyphColors.js

[seiyria]

I would suggest that effects are also interesting - I've had many people ask me specifically what fountains do, what thrones do, etc.

Sure, I just think it's a pretty daunting task, especially if using a limited tool like github wiki. At least I could automate that. I don't know if I could automate, say, a wikia. The problem here is if I change anything, all of the corresponding documentation also has to update, while still preserving any user-made changes (if any at all). I can tell you if I go on an update spree and have to change a bunch of classes, I'm going to be hesitant to do it because then I'd have to update the documentation for all of them as well.

If you're willing to help, that would be better, but this is not my main project anymore - I only periodically work on it.

The coloring you're looking at is correct, where the colors are specified. Item colors are unspecified (potions, etc) and are generated at runtime.

[Serverfrog]

Thats okey that this is not your main Project ;)
But i would say that a wikia is a bit overkill.
Im currently at work so i can currently do not so much, but with a Github wiki/page it will be easy to automate specific values in that Wiki/Page (branch gh-pages maybe?).
But yes i try to help and i agree that effects are also interesting. But to start with only things that are more permanent should written in a Wiki/Site, Like what specific things (thrones,fountains,races) does and not so much effect values.
Something like Effect from Fountains are: Drop Gold, Spawn Monsters or does simply have no effect. In my opinion that wiki should not write everything because the game builds a bit on the randomness and secretes which should be discovery, but a primitiv functionality.

[Serverfrog]

The Non-plus-ultra would be that the wiki would be build in like the existing hovertextes.

[seiyria]

gh-pages is where I publish the game, so that's not likely to work. You would have to use the github wiki, I think that's at https://github.com/seiyria/Roguathia.wiki.git but I'm not sure.

Yes, I agree that it shouldn't spoil everything, but it's difficult to discern what's good to publish and what's not.

I'm not sure what there are to, say, races and professions, besides their values. Obviously that's what people would want to see, right?

I'm actually confused. You first said you wanted a wiki, now you want it built into the game for tooltips(?), or just built into the game? You've also suggested that it should just be documentation, so is it even user-editable (if not, that's not a wiki)?

You're going to need to clarify specifically what you want before anything can be done.

[Serverfrog]

Thats right, i had many ideas and tried to put them all together ;)
Firstly, you are right with the Wiki as here stated.

Then to the documentation/wiki. Firstly is the need to have a developer documentation not needed, because this project have no high priority. That kills the Wiki with values. The Second thing what to display. I would like to say a small information like As monster somebody can't open doors (as far as i read it on reddit), or default Stats of a Race.
The problem with the values that can be changed could be terminated with a intigration into the ui, like it is by the upgrades Like by the Trait: L. CHA upgrade the text Lesser CHA grants +1 CHA when assigned to a character. is shown. That could be done by many things. By the Upgrade of Fountains could stand what they to on the first upgrade and by the unlocking of races/traits could stand the specific Specials.

I'm not so much in JS but i can read the code good, that means i could help to upgrade mainly the text in the tooltips