Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Fix misprint for iconspath #2926

Open
wants to merge 1 commit into
base: master
from

Conversation

@antoniou79
Copy link
Contributor

@antoniou79 antoniou79 commented Apr 7, 2021

The configuration key "iconpath" is actually "iconspath"

Also, there's more to explain about this feature, but it would probably bloat the details table cell for a minor feature that probably not many people use.

Anyway, for reference the code seems to accept naming formats of:

  • (gameid).(extension), where gameid is as it appears in scummvm.ini for the game entry
  • (engineid)-(gameid).(extension), where engineid and gameid are as they appear in scummvm.ini for the game entry
  • (gameTarget).(extension), where gameTarget is the "tag" as it appears in scummvm.ini for this game's entry section, which is also what is exposed to the ScummVM launcher GUI as "ID". (Our documentation currently actually points to this one).

If the iconspath is empty or missing, the code will also look for an extrapath --another configuration key, but one which is exposed to the ScummVM launcher GUI, and has a global value and a per-game entry, under Options->Paths (tab)->Extra Path (field) or Edit Game... ->Paths (tab)->Extra Path (field) ).

Finally, within the path specified either in iconspath or the extrapath (if the iconspath is empty/undefined) the icons can either reside directly into that folder path or within a subfolder named "icons".

This is based on the source code in file: common/taskbar.h

@antoniou79 antoniou79 requested a review from cadihowley Apr 7, 2021
Copy link
Contributor

@cadihowley cadihowley left a comment

Ok... so there's more than one thing wrong in the docs then - as you said, gameid is not the same as what's displayed in the GUI ID field, and therefore those two shouldn't be linked in the docs! Another item on the to-do list...but for now, we could probably try and give as much info for iconspath as possible?

What about:

Icon files can follow any of these naming conventions, where xxx is the file extension:
  - gameid.xxx
  - engineid-gameid.xxx
  - gametarget.xxx. Gametarget is the name of the game listed in square brackets in the configuration file, or in the :ref:`ID <gameid>` field in the GUI.
Icons must be ICO files on Windows, and PNG files on macOS.

Or is that too much? Happy to merge just the fix for the spelling mistake for now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants