Difference between revisions of "User Manual/TODO"
Jump to navigation
Jump to search
(update list of tasksand update new structure description) |
|||
Line 11: | Line 11: | ||
== Manual Proposed Reorganization == | == Manual Proposed Reorganization == | ||
1. Introduction | 1. Introduction | ||
What is ScummVM? | |||
2. Quick Start | |||
This would look like a platform-independent tutorial of the whole process, up to launching a game. One of the freeware game can be used as an example so that the user can try it himself. | |||
This should be short and well illustrated. All subsections here would also have a link to the more detailed section. | |||
2.1 Installing ScummVM | |||
2.2 Installing a game for use with ScummVM | |||
2.3 Adding a game in ScummVM | |||
2.4 Running a game in ScummVM | |||
2.5 Where to get help? | |||
2. | 3. ScummVM Interface | ||
3.1 Main Window | |||
3.2 Options | |||
3.3 Game settings | |||
3.4 In-game menu ''(with a list of games that keep to their own menus)'' | |||
4. Using ScummVM | |||
4.1 Installing ScummVM ''(on all platforms)'' | |||
4.2 Configuring ScummVM ''(describing the settings and command-line parameters)'' | |||
4.3 Installing a game for use with ScummVM ''(covering multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks)'' | |||
4.4 Adding and Running a game in ScummVM ''(and creating batch files)'' | |||
4.5 Configuring a game in ScummVM ''(adjusting per-game settings, describing why 3x scaler makes 640x480 games run in a smaller window than oldies...) | |||
4.6 Removing a game from ScummVM | |||
4.7 Uninstalling ScummVM ''- ? Why would they even think about that?!'' | |||
5. Getting help | |||
5.1 FAQ ''- ? Would threads like these: | |||
'Why isn't my Torin's Passage detected by ScummVM?' - 'It is probably not supported by now. See compatibility page here (link).' | |||
qualify as 'frequently asked'? Or 'There is no sound'? 'My game crashes'?'' | |||
5.2 Contacts | |||
5.3 Reporting bugs | |||
6. Appendix | |||
Contains comprehensive technical information. | |||
6.1 Command line options | |||
6.2 Config file description | |||
6.3 Tools | |||
6. Appendix | |||
Contains comprehensive technical information. | |||
== Discussion on Proposed Reorganization == | == Discussion on Proposed Reorganization == | ||
Line 67: | Line 64: | ||
== TODO == | == TODO == | ||
=== Reorganize the content as described above === | === Reorganize the content as described above === | ||
Pages have now be renamed or created to complies with the new structure. However some content still needs to be moved from the renamed pages to the created pages. | |||
=== Add ScummVM and game installation instructions === | === Add ScummVM and game installation instructions === | ||
Line 172: | Line 99: | ||
* Launcher's 'Load Game' window (with a list of games that cannot be loaded this way). | * Launcher's 'Load Game' window (with a list of games that cannot be loaded this way). | ||
* [TODO: complete list] | * [TODO: complete list] | ||
=== Appendix === | |||
* Write command line options page | |||
* write config file description | |||
* check the list of tools, their description and their command line arguments are up to date |