Difference between revisions of "User Manual/Adding a game to ScummVM"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Add unknown game variant section)
 
Line 11: Line 11:
 
# {{ManualScreenshot|name=Massaddbrowse.png | desc=File browser for mass add}} You will then be presented with the same file browser that we used previously to select just one game. This time, however, click [[Image:Choose.png|60px|Choose]] when you are in the top-level directory which all your game directories are inside.{{-}}
 
# {{ManualScreenshot|name=Massaddbrowse.png | desc=File browser for mass add}} You will then be presented with the same file browser that we used previously to select just one game. This time, however, click [[Image:Choose.png|60px|Choose]] when you are in the top-level directory which all your game directories are inside.{{-}}
 
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.{{-}}
 
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.{{-}}
 +
 +
== Unknown game variants ==
 +
{{ManualScreenshot|name=Unknown game dialog.png|desc=Unknown game dialog}}
 +
{{ManualScreenshot|name=Unknown game ticket.png|desc=Unknown game ticket}}
 +
If the version of the game you have is not one already known to us, a dialog will be shown with the detection information that you need to provide to the team. In the dialog you will have the option to:
 +
* Report the version to us. This will automatically create a ticket on [https://bugs.scummvm.org our bug tracker] with the detection information. Please add the game name, version and language to the ticket description before submitting it.
 +
* Copy the detection information to the clipboard. You can then paste it manually when reporting the unknown game variant to us.
 +
 +
Depending on the game, the dialog may then let you add the unknown game variant to ScummVM or not. If the option to add the game to ScummVM is present, reporting this version to us is still useful so that we can add proper support for it.
 +
{{-}}
  
 
{{ManualFooterLinks|prev=Installing a game for use with ScummVM|next=Configuring a game in ScummVM}}
 
{{ManualFooterLinks|prev=Installing a game for use with ScummVM|next=Configuring a game in ScummVM}}

Latest revision as of 22:49, 4 June 2020

Adding one game to the ScummVM Launcher

Before you can play a game using ScummVM, you first need to add it to the Launcher.

  1. Your game will run more smoothly if you copy all the files from the original disk(s) (whether floppy or CD) into a folder on your hard-drive. You can see which files you need for each game on the Datafiles page.
  2. The ScummVM Launcher
    Click on the Add Game button on the right-hand side of the Launcher.
  3. Add Game Dialog Box
    You will now be presented with a file browser. You should use this browser to locate the directory in which the files from your game's disks are located. Double click on the name of a directory to go into it, and use the Go Up button to go back up one level. Once you are in the correct folder, click the Choose button.
  4. Game Settings Dialog Box
    If ScummVM detected the game correctly, it will now display a dialog box which lets you change various settings about the game, including the name that appears in the main window of the Launcher. There are six tabs full of settings to change, and these are discussed later on in the configuration section, but you don't need to change any of them. To finish adding your game, just click the OK button.
  5. The ScummVM Launcher with one game added
    Tada! You've added your first game to ScummVM. To play it now, just select the game you want to play and click on the Start button.

Adding multiple games at once

  1. Confirmation dialog for mass add
    If all of your games are in separate subdirectories of one "games" directory, you can add all of your games at once. Simply hold down the "shift" key, and the Add Game button. Add Game will switch to being a Mass Add button. If you click on it, the ScummVM Launcher will ask you to confirm that you really do want to do this.
  2. File browser for mass add
    You will then be presented with the same file browser that we used previously to select just one game. This time, however, click Choose when you are in the top-level directory which all your game directories are inside.
  3. Mass add complete
    The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.

Unknown game variants

Unknown game dialog
Unknown game ticket

If the version of the game you have is not one already known to us, a dialog will be shown with the detection information that you need to provide to the team. In the dialog you will have the option to:

  • Report the version to us. This will automatically create a ticket on our bug tracker with the detection information. Please add the game name, version and language to the ticket description before submitting it.
  • Copy the detection information to the clipboard. You can then paste it manually when reporting the unknown game variant to us.

Depending on the game, the dialog may then let you add the unknown game variant to ScummVM or not. If the option to add the game to ScummVM is present, reporting this version to us is still useful so that we can add proper support for it.



Prev: Installing a game for use with ScummVM Back to Table of Content Next: Configuring a game in ScummVM