Template talk:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
No edit summary
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== 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. [[User:Kolano|Kolano]] ([[User talk: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? - [[User:Xerxes|Xerxes]] ([[User talk: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.[[User:Kolano|Kolano]] ([[User talk: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. - [[User:Xerxes|Xerxes]] ([[User talk:Xerxes|talk]]) 11:06, 19 December 2017 (CET)
Looks good, thanks for addressing it. [[User:Kolano|Kolano]] ([[User talk:Kolano|talk]]) 11:19, 19 December 2017 (CET)
== Config List ==
== 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.
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.
Line 6: Line 17:
2. A list of functions in the emulator and what they do and where they are.
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? - [[User:MaJoR|MaJoR]] ([[User talk:MaJoR|talk]]) 15:23, 13 July 2014 (CEST)
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? - [[User:MayImilae|MayImilae]] ([[User talk: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. [[User:mbc07|mbc07]] ([[User talk:mbc07|talk]])


: 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. [[User:Jhonn|Jhonn]] ([[User talk:Jhonn|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. - [[User:Xerxes|Xerxes]] ([[User talk:Xerxes|talk]]) 09:43, 18 December 2017 (CET)


== Misalignment with Current Rev ==
== Misalignment with Current Rev ==
Line 22: Line 35:
* We should properly split out the GC options. And the missing Device Settings may be needed for a few games (i.e. GC Mic).
* 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.
* 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 ===
=== Game Properties ===
We don't cover...
We don't cover...
* Skip DCBZ clearing
* Skip DCBZ clearing
* New Idle Skipping options
 
-----
-----
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. - [[User:Jhonn|Jhonn]] ([[User talk:Jhonn|talk]])
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. - [[User:mbc07|mbc07]] ([[User talk:mbc07|talk]])
 
== Output Per Rating ==
We should revise this to output alternate config section messages based on ratings (i.e. output a less certain message on titles without a rating). [[User:Kolano|Kolano]] ([[User talk:Kolano|talk]]) 09:18, 6 August 2016 (CEST)
 
== Remaining Gaps ==
A few gaps remain in some outputs of the config template. Specifically when outputting multiple config sections while skipping over some sections. This is documented at [[:Template:Config/sandbox/doc]]. [[User:Kolano|Kolano]] ([[User talk:Kolano|talk]]) 08:31, 10 November 2016 (CET)

Revision as of 11:19, 19 December 2017

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)