Help me document springsettings on the wiki?

Forboding Angel · Post by **Forboding Angel** » 21 Feb 2013, 03:41

Here is a sanitized list of springsettings possible settings, the problem is, not all are clear on what they actually do.

I think it would be Nice to have full documentation.

I have set up a wiki page here: http://springrts.com/wiki/Spring-config

It's already formatted, just needs descriptions.

Here is a raw springsettings file (cleaned but without values)
http://paste.springfiles.com/view/648280bc

Somewhat loosely related to this mantis entry: http://springrts.com/mantis/view.php?id=3482

Shadowfury333 · Post by **Shadowfury333** » 21 Feb 2013, 09:09

I've added some entries for various water related settings, mostly BumpWaterReflection and BumpWaterRefraction as far as otherwise undocumented settings go.

Forboding Angel · Post by **Forboding Angel** » 21 Feb 2013, 11:53

Nice! Thanks!

I'm going to try to get all the ones I know tomorrow. Sadly, there are a lot that I don't have a clue.

Shadowfury333 · Post by **Shadowfury333** » 24 Feb 2013, 09:19

Hmm. FontOutlineWeight is bizarre. I thought it was opacity for the outline around text, but it seems to affect the opacity of the text itself.

Also added info for several other settings.

FLOZi · Post by **FLOZi** » 24 Feb 2013, 10:31

http://springrts.com/wiki/Springrc

Forboding Angel · Post by **Forboding Angel** » 24 Feb 2013, 13:27

We can do a little bit better than a dump can't we? Please bother to at least compare.

FLOZi · Post by **FLOZi** » 24 Feb 2013, 14:00

Merely pointing out that a page already existed and you made a second one, in the long term, they should be reunified.

Also, copy-pasting style like that is horrible

, please make a template!

knorke · Post by **knorke** » 24 Feb 2013, 18:58

We can do a little bit better than a dump can't we?

acuelly, probally not, at least not as up to date. the descriptions would better be added to engine (like some already are) so that each new release it one only needs to run spring --list-config-vars to get all new default values etc.

If it needs to look nicer, better idea is imo to make a search&replace script that turns the output into something nicer.

FLOZi · Post by **FLOZi** » 24 Feb 2013, 19:22

Also this abuse of the save button is not acceptable, ShadowFury please learn to preview:

http://springrts.com/wiki/Special:RecentChanges

N.B. (Even at this zoom, the image doesn't capture all of it!)

You may wish to familiarise yourself with the editing guidelines:

http://springrts.com/wiki/SpringWiki#Editing_Guidelines

Forboding Angel · Post by **Forboding Angel** » 25 Feb 2013, 00:11

FLOZi wrote:Merely pointing out that a page already existed and you made a second one

Springrc is linux specific. A windows users searching for it would not know that springrc == springsettings.cfg. Spring Config is much more generalized to all platforms. Also, in the h1 tags, there is Springsettings and Springrc so that google will pick it up and searching for springsettings will garner the correct result.

Well, ideally I would add CSS and divs, but I don't have access to the site css, and I don't think that adding block html/css into the header of a wiki page works.

Code: Select all

<head>
<style>

.defvalue {
	color:#cccccc;
	text-shadow: #111 2px 2px 2px;
}

.safemode {
	color:#ff4500;
	text-shadow: #111 2px 2px 2px;
}

.minvalue {
	color:#00ff00;
	text-shadow: #111 2px 2px 2px;
}

.maxvalue {
	color:#ffd100;
	text-shadow: #111 2px 2px 2px;
}

</style>
</head>

Edit: I was right, it doesn't work.

All the tags are the same, so 2 minutes in notepad++ could switch it all. Assuming you aren't bad with search/replace.

Edit2: Added a bunch of descriptions.

FLOZi · Post by **FLOZi** » 25 Feb 2013, 01:26

Forboding Angel wrote:
FLOZi wrote:Merely pointing out that a page already existed and you made a second one

Springrc is linux specific. A windows users searching for it would not know that springrc == springsettings.cfg. Spring Config is much more generalized to all platforms. Also, in the h1 tags, there is Springsettings and Springrc so that google will pick it up and searching for springsettings will garner the correct result.

Then make a redirect...

Well, ideally I would add CSS and divs, but I don't have access to the site css, and I don't think that adding block html/css into the header of a wiki page works.

Edit: I was right, it doesn't work.

All the tags are the same, so 2 minutes in notepad++ could switch it all. Assuming you aren't bad with search/replace.

Edit2: Added a bunch of descriptions.

As I said, make a template, then the styling is in one place (and as its a wiki page, easy to edit rather than having to access the site css)

c.f. Template:Tag which also makes an anchor so you can link people directly to the tag / setting in question.

Shadowfury333 · Post by **Shadowfury333** » 25 Feb 2013, 23:36

I was editing multiple sub-categories. I don't know why it doesn't show up in the logs, but the way that page is structured, sub-category editing is much more natural and a hell of a lot easier than trying to scroll through the whole page in edit mode.

Forboding Angel · Post by **Forboding Angel** » 26 Feb 2013, 02:00

As weird as it sounds, it's an seo thing. I mean, that's a big part of my day job, and the easiest thing to impact your seo is to have properly structured headings.

To me the way I do it seems very "normal" but I guess that may not be the case. I treat page content like a presentation outline. Search engines like it and it makes it easily readable too.

What annoys me about the wiki though, is that the css for the header rules is pretty terrible, and the way that the navigation is generated is really poor as well.

I vastly prefer Dokuwiki over mediawiki. Much of the features that dokuwiki has make mediawiki look very primitive. *shrug*

Thanks for all your help, shadow!!!

AF · Post by AF » 27 Feb 2013, 11:12

Forboding Angel wrote:As weird as it sounds, it's an seo thing. I mean, that's a big part of my day job, and the easiest thing to impact your seo is to have properly structured headings.

To me the way I do it seems very "normal" but I guess that may not be the case. I treat page content like a presentation outline. Search engines like it and it makes it easily readable too.

What annoys me about the wiki though, is that the css for the header rules is pretty terrible, and the way that the navigation is generated is really poor as well.

I vastly prefer Dokuwiki over mediawiki. Much of the features that dokuwiki has make mediawiki look very primitive. *shrug*

Thanks for all your help, shadow!!!

Indeed but all of that can be remedied here:

https://github.com/spring/spring-websit ... /mediawiki

A good Mediawiki enough theme would beat out the dokuwiki stuff anyway, and we've too much baggage to switch, so it's not going to happen. Headings are also important for automatic tables of contents, JS libraries, and accessibility. Not to mention apps like safaris reading mode etc

Forboding Angel · Post by **Forboding Angel** » 27 Feb 2013, 11:48

I never said anything about switching. Jesus...

abma · Post by **abma** » 15 Mar 2013, 07:11

Forboding Angel wrote: Springrc is linux specific. A windows users searching for it would not know that springrc == springsettings.cfg. Spring Config is much more generalized to all platforms. Also, in the h1 tags, there is Springsettings and Springrc so that google will pick it up and searching for springsettings will garner the correct result.

what? no! thats wrong. only the filename is different... this is why i added a redirect springsettings.cfg -> springrc (which was changed by flozi...)

also i guess it will be horrible to keep this page up to date, better add the descriptions to the engine and create a script which generates a fancy html page from the console output.

this script could be used for the output of spring --list-def-tags and --list-config-vars.

FLOZi · Post by **FLOZi** » 15 Mar 2013, 08:21

Really? I don't recall changing any redirects

edit: Ah, it became a double-redirect due to Forb blanking springrc and redirecting to his new page

Forboding Angel · Post by **Forboding Angel** » 15 Mar 2013, 20:09

I did not blank springrc. I only redirected it.

Edit: At your suggestion, Flozi.

knorke · Post by **knorke** » 15 Mar 2013, 20:20

http://springrts.com/mediawiki/index.ph ... ldid=26292 had some more infos that are not present on the redirect page, like "to list all possible settings, run spring --list-config-vars" that should be checked before making redirects..

Spring RTS Engine

Help me document springsettings on the wiki?

Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?

Re: Help me document springsettings on the wiki?