Template talk:Config

More Appropriate Text

It would be nice if we could key into a titles rating to provide more appropriate text here. Currently the config section will say "This title doesn't need non-default settings to run properly" for 3 or lower rated titles, which likely should be handled differently. Kolano (talk) 07:35, 17 December 2017 (CET)

What are you thinking it should say instead? Something like "This title has known emulation issues which cannot be worked around by configuration" for below 5 stars without any config entries? - Xerxes (talk) 09:32, 18 December 2017 (CET)

Something along those lines, we at least shouldn't be indicating that non-5 start titles won't require config changes. At the same time we need to keep the phrasing vague, since presumably some 4 star titles are actually unaccounted for perfects. So some subtly is required, but probably not too hard to account for beyond the rating integration.Kolano (talk) 06:25, 19 December 2017 (CET)

I just made it say what it said before only for 5 star games, and changed the message for games with any other rating to "No configuration changes are known to affect compatibility for this title." That seemed general enough to me, and it removes the "run properly" part that was bugging you. - Xerxes (talk) 11:06, 19 December 2017 (CET)

Looks good, thanks for addressing it. Kolano (talk) 11:19, 19 December 2017 (CET)

Config List

Remember the Dolphin Manual? Well, I've thought about it a lot since that project failed, and really the dolphin manual was only two things.

1. A list of instructions for set up and doing various things. The wiki already has most of that in Help:Contents via our tutorials.

2. A list of functions in the emulator and what they do and where they are.

We already have #1. However, it occurred to me that we already have #2 as well... right here. Template:Config. It lists all of the options in the emulator, shows where they are (general location via categories anyway) and describes them. The problem is that it is very user unfriendly. It's designed to display stuff in wiki pages, and it does that job very well but it's not very friendly for other purposes. So, here's my question to you guys - how hard would it be to make a page that automatically displayed every Template:Config entry? That way, any time Template:Config is updated, the big user-friendly list would be updated as well. With a little tweaking to make it more presentable, we take what we already have and maintain and suddenly it's a one-stop shop for Dolphin help, fulfilling everything the Dolphin Manual set out to achieve! But uh, I don't know how to do that. You know, artist and all. What do you guys think? - MayImilae (talk) 15:23, 13 July 2014 (CEST)

It'll need some refactoring to automatically add new option to a list and the template's code is messy at the moment. A temporary solution is creating a page and include Config template with every possible entry and then update accordingly whenever we add new options. It's a quick way to archive #2 until we refactor the template's code. mbc07 (talk)

The template is changed so rarely that I've just been doing this by hand at Template:Config/testcases. Since the preview of the options on the documentation has to be updated anyways, it's really not that hard to just copy/paste the complete empty template from Template:Config/doc to the testcases page and fill in nonsense for all the options. There's no need for this kind of automation at all, nor do I know a good way to do it. - Xerxes (talk) 09:43, 18 December 2017 (CET)

Misalignment with Current Rev

There seem to be quite a few mis-alignments with the template and the current config options. I'll try to list the ones I'm seeing, I didn't cover the Graphics tab in detail...

General

• Framelimit options were revised, now is set 10 - 200% rather than by individual frames.

Under our General, but Configs Interface

• Panic Handlers, do we need to cover this option?

GC/Wii

• We should properly split out the GC options. And the missing Device Settings may be needed for a few games (i.e. GC Mic).
• Under Wii we only miss the Aspect Ratio options. Probably safe to ignore, but may effect some games 16:9 support.

Controllers

• Sideways remote

Game Properties

We don't cover...

• Skip DCBZ clearing

---

Panic Handlers were added because in the past some games worked fine but threw a lot of Error Messages. If we don't have games needing it anymore I'm OK with its removal. Otherwise I think it should stay. About Aspect Ratio in Wii tab, we could implement it for games like WarioWare Smooth Moves that outputs stretched graphics at 16:9 because it doesn't have widescreen support. It may be cleaner than suggesting the users to use "Force 4:3" in graphics config. Despite these two notes, I agree with everything else. - mbc07 (talk)

Deprecated/INI-only settings

• fullres - INI contains FullscreenDisplayRes (formerly FullscreenResolution) but unavailable on UI https://github.com/dolphin-emu/dolphin/pull/6196 , not found on GameINI either and I'm not sure if it's still relevant if it even works there...
• ntscj - which was for a "Force Console as NTSC-J" setting on UI, I suspect this was replaced by "Fallback Region" on the UI. Would we want to replace this with a new parameter?

Should we add them to the list of deprecated settings or just delete them totally? Also should "patches" parameter have a place in this template? I see they're next to Action Replay and Gecko Code tabs in the game properties but they don't have their own parameters in this template. Lucario (talk) 10:27, 8 February 2022 (CET)

Yeah, we need to clean up ntscj, the only title currently requiring it is Kururin Squash!. Presuming we can clean it up with current settings I think we should probably just purge the old settings once the clean up is complete. Kolano (talk) 04:49, 9 February 2022 (CET)

Would it be safe to assume Kururin Squash! can just switch to the new setting parameter? Lucario (talk) 01:57, 11 February 2022 (CET)

After reading https://github.com/dolphin-emu/dolphin/pull/6172, they said Dolphin can handle this automatically by region detection, IDK which revision Dolphin became able to. The issue entry appears to be created along with the game page creation which dated back to March 2011 who knows when it's resolved and we don't usually keep the old entries solved before 5.0 release. I think it's not worth investigating but simply wipe the old settings. Till then when someone willing to bother testing and wants to re-add. Lucario (talk) 00:15, 14 February 2022 (CET)

Template:Config/sandbox#Issues

I feel that they can be ignored as it would be an overdo if any one of these are to be resolved, they are there for producing quality categories against misformatted settings. I hope it wouldn't be too confusing when trying to add future new settings into config template but I think writing some editor notes can help. Anyone else okay with what we have currently? Lucario (talk) 03:08, 11 February 2022 (CET)

Template:Config/sandbox#Features

Is everything a good addition? I feel they're ready to ship outside the sandbox. Lucario (talk) 03:08, 11 February 2022 (CET)

Will apply changes to outside of the sandbox soon if no one have objection to it. Lucario (talk) 03:20, 14 February 2022 (CET)

I missed this talk section, sorry. After a brief review, unfortunately I'm against most of the proposed changes:

• Path to settings: makes the output table too crowded and is also redundant (kinda), considering we already group the relevant settings on individual tables (e.g. settings you'll find on the Graphics configuration are on its own table under the Graphics heading and so on).

• GameINI counterparts: suffers from the same issue of making the output table too crowded and can also be a bit confusing in some instances (e.g. keys from different headings grouped in the same table). I don't think the matching INI key is important enough to deserve its own column, especially when we already have the GameINI page in a featured position (readily accessible from any wiki page via the sidebar link) and also considering we only list settings when they deviate from the defaults (aka it gets wiped from the game page once the built-in GameINI that ships with Dolphin gets updated).

• Using Template:Config required: I see some potential here, but I don't agree with the implementation. Most of the logic of this new sub template is to handle the proposed GameINI column (which I think should be dropped anyway) and from a maintenance perspective I'm definitely not convinced it provides "improved editing performance": the template code is still as complex as before and you now have two different places you'll potentially need to edit in case the template logic needs an update for whatever reason. I do like the input validation via the new category, though, but that can be implemented directly on the main template instead of relying on a sub template.

To summarize, I'm supportive of the input validation feature if it gets reworked directly in the main template but the rest is a hard pass from me. - mbc07 (talk) 19:12, 14 February 2022 (CET)

I'd need some more time to review these, but also think some of the extended details may be too much. It probably would be good if we could better interlink these and the Config/GameINI pages; but don't think we need to expose as many details in the config template tables. Kolano (talk) 23:49, 14 February 2022 (CET)

Relabelling Settings

Should we relabel settings to reflect current Dolphin UI? Should parameters also follow up? Lucario (talk) 03:08, 11 February 2022 (CET)