Stop misusing config.txt's block format

[hakore]

Resurrecting topic.

I definitely agree with piroJoke:
http://bibian.ath.cx/openkore/viewtopic.php?t=36627

The block format of config.txt is being misused...

What good does it do puting teleportAuto in curly brackets when you don't even have to type the teleportAuto_* options multiple times in config.txt like you would for attackSkillSlots? Laziness? Cosmetic makeover?

Anyways, it's already in SVN. I could have opted to have it rolled back, but that would be too disrespectful. We'll just find ways to make teleportAuto justified as being config blocks.

But from now on, please don't get the idea of converting another inline option set to config blocks for the mere sake of removing "prefixes" and making it look neater. That is not the sole purpose of config blocks.

Actually, even equipAuto requiring no particular value for the config block option is not good.

Thanks.

[sli]

Yeah, I'm gonna have to agree with you and piroJoke. There's isn't any conceivable reason to make a block because there's no reason to have more than one teleportAuto block, they'd just conflict unless there was a way to switch between which one was being used (see below).

Code: Select all

# enable with console command 'teleport farming'
teleportAuto farming {
    maxWeight 50
    respawn 1 # fake option
}

# enable with console command 'teleport grinding'
teleportAuto grinding {
    maxWeight 90
    respawn 1 # fake option
}

# enable with console command 'teleport blahblah'
teleportAuto blahblah {
    respawn 0 # fake option
    default 1 # fake option, denotes that this block should be the default when Kore starts
}

But since I don't see this happening, the change will just increase startup time.

[kali]

Well, there's still a chance to roll it back. From what I remember it's just a cosmetic change - the old format still works.

isieo, how about it? I don't think many people are using the new format yet. If we drop it now while it hasn't gained traction yet, it won't affect much of the users.

There's still hakore's config checker too

[Cozzie]

As a cosmetic change I think it is much more nicer to use. Since teleport block isnt going to be used for multiple block, the change has no effect at all. Why not retain the changes but in the default config retain the old style?

[hakore]

First off, this is rather harder to maintain in terms of support and documentation.

The teleportAuto_* option set is not the only inline config option set that share a common prefix. To mention a few, there's attackEquip, storageAuto, and sellAuto. Talk about slippery slope, people would eventually ask why not, and most will simply assume that, these other prefixed config options can also be placed in curly bracket format like the teleportAuto. Lot's of confusion.

And how would you describe it in the manual? "You can specify multiple instances of config blocks in config.txt EXCEPT for teleportAuto, etc." Hmm... consistency anyone?

While I do not disagree on cosmetic changes in config.txt, using the config block format for the supposed inline config options is not the solution. It's ultimately confusing.

If you really want to make a config.txt makeover for prefixed config options, we can discuss other schemes without reusing the config block format.

For example, by using an underscore notation, like so:

Code: Select all

teleportAuto
_hp 10
_sp 0
_idle 0
_portal 0
_search 0
_minAggressives 0
_minAggressivesInLock 0
_onlyWhenSafe 0
_maxDmg 500
_maxDmgInLock 0

or a dot, like so:

Code: Select all

teleportAuto
.hp 10
.sp 0
.idle 0
.portal 0
.search 0
.minAggressives 0
.minAggressivesInLock 0
.onlyWhenSafe 0
.maxDmg 500
.maxDmgInLock 0

or a dash, like so:

Code: Select all

teleportAuto
- hp 10
- sp 0
- idle 0
- portal 0
- search 0
- minAggressives 0
- minAggressivesInLock 0
- onlyWhenSafe 0
- maxDmg 500
- maxDmgInLock 0

or probably a square bracket enclosure:

Code: Select all

teleportAuto [
	hp 10
	sp 0
	idle 0
	portal 0
	search 0
	minAggressives 0
	minAggressivesInLock 0
	onlyWhenSafe 0
	maxDmg 500
	maxDmgInLock 0
]

The important thing is to make a clear distinction between the repeatable block options and the non-repeatable (originally inline) options.

[kali]

Clear distinction is a good argument.

Hopefully someone can modify the block format to use square brackets too (as that would probably be the easiest to change).

[hakore]

Actually, I already devised how this will be implemented in code. I just need the consent of the other devs in respect to the earlier teleportAuto format.

[Cozzie]

Clear distinction to prevent confusion is a very strong argument. Consistency is a main factor in usability. I agree with kali and hakore's suggestion of using square brackets.

[Kissa2k]

For users there is no matter which teleport syntax is using in openkore

[isieo]

well, we could just set the default autoTeleportConfig block in config.txt back to _ format again since it will still work and people using the {} method will also still work.

(X_X" i gave people a week to post their ideas on it and no one object that time. maybe we should have a new system for features.)


PS. openKore is an open sourced project, if you want to change anything go ahead but just post about it. there is no ownership in pieces of codes.