Template talk:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
m (Comment on fpsforlimit ?)
(75 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==To Do==
== More Appropriate Text ==
*Add "Resolution" setting for titles like Mega Man, which are sensitive to particular resolutions.
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)
*Fix alternate row shading. Unfortunately the nested if's/tables make this complex.
*Add pop-up descriptions to config settings
*Address bolding of sections beyond first shown /wo including excessive white-space
**The wiki will apparently only appropriately parse "===" enclosed titles as titles if line feeds occur between each section outside of the if's. This unfortunately inserts excess white-space in cases where no sections are shown. Attempted corrections that fail include:
***Adding white-space to the beginning/ends of sections within ifs
***Adding white-space between sections via a secondary set of ifs


==19121 rollback==
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)
I understand a desire to not impact current pages, but we will need to deal with ongoing config changes. We probably need to address such in a manner that preserves old options as input, but displays new options as output.[[User:Kolano|Kolano]] 04:01, 21 June 2011 (CEST)
:I ''absolutely 100% agree'' that we will need to add new parameters to this template over time -- but simply removing and breaking existing parameters that are still in use on many articles is poor practice. This is why I reverted it (for now). The change also broke the feature I added that categorizes articles in need of some parameter updates (see [[:Category:Pages with deprecated config template parameters]]). {{:User:LobStoR/sig}} 18:20, 21 June 2011 (CEST)


::Sorry for the troubles that was caused, the 19121 edit wasn't intended to cause problems, but a merge error in my text editor broke many things... I'll commit it again when I figure out what is going on on my editor, and after this the template will be as was on 19121 but without the compatibility issues and without breaking any new introduced features... [[User:Jhonn|Jhonn]] 21:18, 21 June 2011 (CEST)
: 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)


== Virtual EFB ==
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)
I have a quick question, and don't really know where to go with it. In r7626, and assuming beyond, there are some [http://img535.imageshack.us/img535/8610/efboptions.png new options]. Instead of EFB copies to ram/texture, it has checkboxes, "Virtual" and "Ram". There is nothing in the TODO on how to do this. How should this be shown? Should I just wait for the TODO to be updated? [[User:MaJoR|MaJoR]] 18:19, 26 June 2011 (CEST)


==22715 rollback==
Looks good, thanks for addressing it. [[User:Kolano|Kolano]] ([[User talk:Kolano|talk]]) 11:19, 19 December 2017 (CET)
This appears to have broken the config template on many pages.  Some attributes were in the page source, but were not showing up on the rendered page (something that, by my understanding, we're trying to avoid).  Many pages had a Graphics heading with no entries.  Feel free to undo my undo if there's a bigger project going on here that I'm not aware of. --[[User:Keller999|Keller999]] 09:02, 11 August 2011 (CEST)
:I'm reverting it back, the Native Mipmaps and Accurate Texture Cache options doesn't exist anymore on Dolphin, so I commented out these options on template source until we think in a solution (mantaining these options for reference in older revisions or dropping it at all). [[User:Jhonn|Jhonn]] 21:17, 11 August 2011 (CEST)
:Jhonn (or anyone up for some template fiddling), if you refer to the ratings template you'll see a method of generating categories for erroneous pages. I'd advise we revise the template to handle these options similarly until pages using them can be cleaned up.[[User:Kolano|Kolano]] 03:12, 12 August 2011 (CEST)
::The ratings template is using the same method that I've implemented here for handling errors (checking the input parameters with "if" and adding the pages using the outdated (or deprecated) parameters on their respective category), for the outdated entries, I was thinking in some way of putting them in a small spoiler (for reference of older revisions), but probably implementing this would cause other issues... Should we maintain it or drop at all? [[User:Jhonn|Jhonn]] 21:25, 12 August 2011 (CEST)
:::I would say that most users are using latest SVN (which the template is already being updated for) or 3.0.  The overhead of maintaining every possible old variable would be a lot of work for little payoff.  I'd suggest adding another section for Release 3.0 variables only, in spoiler form.  I would say any release before 3.0 is out of luck.  I may try to work up something in the template sandbox, we'll see what you think.  --[[User:Keller999|Keller999]] 07:29, 14 August 2011 (CEST)
:Just as a suggestion, keeping references for older revisions *only* when the games calls for it, meaning by this that the main pages, for example config and performance, should always be kept with cutting edge revisions and only when the game specifically calls for it, older revisions should be mentioned specifically on X game page needing those, of course this calls for a user looking to use X revision of dolphin for his favorite game.[[User:Otomo|Otomo]] 18:39, 12 August 2011 (CEST)


==Further improvements==
== Config List ==
I've been working on this template a good bit.  I've already committed the documentation page update, but I wanted to get your thoughts before making a big change to something as serious as Template:Config. Here's what already been commited:
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.


* Documentation page re-write. Only current variables are listed, the sample copy-paste block contains all current variables and is broken out so that the list at the bottom is no longer needed.
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.


Here's what I've got teed up, if no one objects.
2. A list of functions in the emulator and what they do and where they are.
* Reformatted [[Template:Config]] to be considerably more readable, with one variable per line and consistent tabbing
* Put variables in the same order as shown in [[Template:Config/doc]], with spacing to show General, Graphics, etc.
* Verified and altered the if checks to see if a box needs to be displayed.  They will only display if non-outdated variables are being used.


Proposed template: [[Template:Config/sandbox]]<br>
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)
Implementation: [[Template:Config/sandbox/testing]]<br>
--[[User:Keller999|Keller999]] 07:26, 14 August 2011 (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]])


In the Graphics field where it says OpenCL texture decoder, perhaps it'd be better to include OpenMP texture decoder instead as that one is not (and quoting dolphin's description) "Experimental" and "known to cause texture defects on various games". Or maybe it's wiser to include both?? [[User:Otomo|Otomo]] 18:52, 15 August 2011 (CEST)
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)


Both should be included for as long as both exist within the Dolphin config options. [[User:Kolano|Kolano]] 21:40, 15 August 2011 (CEST)
== 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...


==fpsforlimit ?==
=== General ===
There's a conflict with the current (and my proposed) Template:Config.  fpsforlimit is both in the current variables section and the "Pages with deprecated config template parameters" section.  I infer that fpsforlimit would indicate what FPS number should be set for FPS limiter, which is definitely still an option in Dolphin.  However, you could also argue that that information should be under Framelimit. Is this an option we should keep?
* Framelimit options were revised, now is set 10 - 200% rather than by individual frames.


In the meantime, I'm going to remove it from [[Template:Config/doc]] so that pages aren't being added to that category left and right.  We can alter [[Template:Config]] once we know which way we fall on this one. --[[User:Keller999|Keller999]] 07:56, 14 August 2011 (CEST)
Under our General, but Configs Interface
* Panic Handlers, do we need to cover this option?


It's still a valid config setting in recent Dolphin releases, so it should be kept. [[User:Kolano|Kolano]] 07:53, 15 August 2011 (CEST)
=== GC/Wii ===
:: I propose that we merge fpsforlimit into framelimit, much in the same way realxfb has been merged into xfb. Since the variables are basically a free-form text field, it would be simple to indicate what fps the game should be limited to either in framelimit or framelimit notesI also think that the variable 'fpsforlimit' is somewhat confusing, and may throw off novice wiki editors. --[[User:Keller999|Keller999]] 22:07, 15 August 2011 (CEST)
* 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. - [[User:mbc07|mbc07]] ([[User talk:mbc07|talk]])

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)