Author Topic: MegaGlest's INI  (Read 1852 times)

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
MegaGlest's INI
« on: 6 May 2011, 18:36:10 »
Two things:

Firstly, I noticed that "MaxUnitSelectCount" was removed in the INI documentation, why is this?

Secondly, are we going to see some of the more obscure, yet more useful parts of the INI documentation updated? In particular, I am referring to "FontConsolePostfix" and related font INI entries, which are very obscure and do not have any description on what they do. Could someone add that description?

https://docs.megaglest.org/MG/INI
« Last Edit: 18 June 2016, 15:22:00 by filux »
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

ultifd

  • Airship
  • ********
  • Posts: 4,443
  • The Glest Video Guy :) The one and only. :P
    • View Profile
    • My Youtube Channel
Re: MegaGlest's INI
« Reply #1 on: 6 May 2011, 22:05:35 »
Firstly, I noticed that "MaxUnitSelectCount" was removed in the INI documentation, why is this?
Now it seems to be broken, somehow. It'll probably be added again after it's fixed...or not.
https://forum.megaglest.org/index.php?topic=7077.msg72523#msg72523

softcoder

  • MegaGlest Team
  • Battle Machine
  • ********
  • Posts: 2,239
    • View Profile
Re: MegaGlest's INI
« Reply #2 on: 7 May 2011, 00:13:25 »
INI entries that are dangerous and should not be changed by non devs are no longer in the wiki for now as they cause instability and exist only for the purpose of development efforts.

Regarding the Font stuff there is no point in documenting it because the current font stuff is hideous quality and will surely be replaced (think freetype or something like what GAE has).

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
Re: MegaGlest's INI
« Reply #3 on: 7 May 2011, 06:20:53 »
INI entries that are dangerous and should not be changed by non devs are no longer in the wiki for now as they cause instability and exist only for the purpose of development efforts.
But the entire point of having it on the wiki is so that we have at least some method of finding out what the INI entry is, dangerous or not. You can always have the description state that it shouldn't be greater than 32. If you want, you could bold and underlined that warning, for all I care, but it should still be there... Can we add it back, please?

And it still would be nice to take 5 minutes to just quickly document the font stuff, because whether or not it will be replaced in the future, it's still there in the current release, and without documentation, it's helping no one. I'd do that myself, but I haven't even the foggiest what it means.
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

ultifd

  • Airship
  • ********
  • Posts: 4,443
  • The Glest Video Guy :) The one and only. :P
    • View Profile
    • My Youtube Channel
Re: MegaGlest's INI
« Reply #4 on: 7 May 2011, 17:00:33 »
Omega, that doesn't really make sense. Why would someone lower down the unit selection count anyways? Default is already 32...  :angel:

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
Re: MegaGlest's INI
« Reply #5 on: 7 May 2011, 17:26:23 »
Omega, that doesn't really make sense. Why would someone lower down the unit selection count anyways? Default is already 32...  :angel:
Options are options. I don't see any sense in modifying, for example, the world refresh rate either (that would break some scenarios, and possibly others) nor turning off error reporting (it will still crash, but without an error), but they still have INI options. In this case, it should be documented, whether or not its feasible to use it. Most people would probably not want it lower, but who knows. At any rate, it should still be documented, simple because it exists. Otherwise, we'd have to remove the other INI options too, to be consistent with such a thing.

As well, for dangerous options, "AllowDownloadDataSynch" is mentioned on the wiki, despite the description stating it should not be used yet, implying it's dev only at the moment.

I re-added it to the wiki with a warning about the maximum. Any legitimate objections to remove, be my guest, but it should still be there. By the way, is the default 32? The current listed default is 16 on the wiki, which I did not create.
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

tomreyn

  • MegaGlest Team
  • Airship
  • ********
  • Posts: 2,764
    • View Profile
    • MegaGlest - the free and open source cross platform 3D real-time strategy game
Re: MegaGlest's INI
« Reply #6 on: 7 May 2011, 21:42:36 »
Right, if one of the main developers of this game and the QA tester are going crazy and say something should be removed off the documentation for some random reasons, at least there is still one sanely minded person around here who will fix things up. We are so lucky.
atibox: Ryzen 1800X (8 cores @3.6GHz), 32 GB RAM, MSI Radeon RX 580 Gaming X 8G, PCI subsystem ID [1462:3417], (Radeon RX 580 chipset, POLARIS10) @3440x1440; latest stable Ubuntu release, (open source) radeon (amdgpu) / mesa video driver
atibox (old): Core2Quad Q9400 (4 cores @2.66GHz), 8 GB RAM, XFX HD-467X-DDF2, PCI subsystem ID [1682:2931], (Radeon HD 4670, RV730 XT) @1680x1050; latest stable Ubuntu release, (open source) radeon / mesa video driver
notebook: HP envy13d020ng
internet access: VDSL2+

· · · How YOU can contribute to MG · Latest development snapshot · How to build yourself · Megapack techtree · Currently hosted MG games · · ·

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
Re: MegaGlest's INI
« Reply #7 on: 7 May 2011, 23:26:29 »
Right, if one of the main developers of this game and the QA tester are going crazy and say something should be removed off the documentation for some random reasons, at least there is still one sanely minded person around here who will fix things up. We are so lucky.
*sigh* I don't mean this as an offense, regardless of how it comes up, it's just that the wiki is meant to document the game, whether or not something is stable, and in this case, it thoroughly states that it is not. Consider it there for posterity.
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

titi

  • MegaGlest Team
  • Airship
  • ********
  • Posts: 4,240
    • View Profile
    • http://www.titusgames.de
Re: MegaGlest's INI
« Reply #8 on: 9 May 2011, 14:33:27 »
? maybe I am too late, but this MaxUnitSelection count is described now in the wiki, but I think the description is wrong .....

maxUnits= 36; is the current max and default!

this was the forum discussion:
https://forum.megaglest.org/index.php?topic=6606.0

this was the checkin:
http://sourceforge.net/apps/trac/megaglest/changeset/1775
Try Megaglest! Improved Engine / New factions / New tilesets / New maps / New scenarios

tomreyn

  • MegaGlest Team
  • Airship
  • ********
  • Posts: 2,764
    • View Profile
    • MegaGlest - the free and open source cross platform 3D real-time strategy game
Re: MegaGlest's INI
« Reply #9 on: 9 May 2011, 15:32:11 »
Apparenlty somebody reverted the change where I removed this option off the INI documentation, making it one of the several non-documented INI options (which can still be found in the source code obviously) which are not documented for a reason. The reason they are not documented differ. Usually it's because they can be abused or can trigger crashes. Had this option not been documented on the INI wiki page in the first place then I would never have run into these crashes.

I am happy to agree with anyone who would say that discussing whether or not having this specific option documented (with a warning as it is now) or not on the wiki is nitpicking. What I really find annoying here is that the needed changes I made on the MG part of the Glest wikia wiki were reverted, without proper discussion, by someone who apparently doesn't understand the implications of providing the average user access to non-failsafe INI options, and that I need to justify for removing the documentation of such a problematic option. This just adds to a series of events where Omega and I seem to have different opinions and he uses his powers to overrule me. Which, yes, I find offending.
« Last Edit: 18 June 2016, 13:18:16 by filux »
atibox: Ryzen 1800X (8 cores @3.6GHz), 32 GB RAM, MSI Radeon RX 580 Gaming X 8G, PCI subsystem ID [1462:3417], (Radeon RX 580 chipset, POLARIS10) @3440x1440; latest stable Ubuntu release, (open source) radeon (amdgpu) / mesa video driver
atibox (old): Core2Quad Q9400 (4 cores @2.66GHz), 8 GB RAM, XFX HD-467X-DDF2, PCI subsystem ID [1682:2931], (Radeon HD 4670, RV730 XT) @1680x1050; latest stable Ubuntu release, (open source) radeon / mesa video driver
notebook: HP envy13d020ng
internet access: VDSL2+

· · · How YOU can contribute to MG · Latest development snapshot · How to build yourself · Megapack techtree · Currently hosted MG games · · ·

ultifd

  • Airship
  • ********
  • Posts: 4,443
  • The Glest Video Guy :) The one and only. :P
    • View Profile
    • My Youtube Channel
Re: MegaGlest's INI
« Reply #10 on: 9 May 2011, 23:05:10 »
36, right.

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
Re: MegaGlest's INI
« Reply #11 on: 10 May 2011, 00:19:31 »
Had this option not been documented on the INI wiki page in the first place then I would never have run into these crashes.
Thus the reason to have warnings on the page. Documentation is a good thing. You can document the parts and functions of an atomic bomb, and while 99% of people would use that knowledge appropriately, someone can, of course, abuse it by creating a weapon of mass destruction. Or another example, you can state that you can create an emanation that will make a negative move speed, but WARN the user this could go very badly and advise against it. This one is a real life example found on the very wiki you are complaining about.

This just adds to a series of events where Omega and I seem to have different opinions and he uses his powers to overrule me. Which, yes, I find offending.
Anyone can edit, and that's the good thing about the wiki, which, again, is to document and explain Glest fully. If you really want, go ahead and split it into a separate table of "dangerous" INI values, but it still should exist.

As for the value of 36, I did not change that at all, and it is the same as added previously by a MegaGlest team member. I changed nothing but adding it back in. I don't mean to cause any disarray, and your sarcasm is wasted on me Tom, just that the wiki is a team effort, and if it comes between to document or not to document something, if there exists willing people, they can document it. Removal of content should be avoided. Even poorly written content is better off being rewritten than removed. As well, remember, all editors are equal.
« Last Edit: 18 June 2016, 13:05:32 by filux »
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

 

anything