Ticket #11391: QuickStartUPDATED.txt

File QuickStartUPDATED.txt, 6.8 KB (added by IlDucci, 4 years ago)
Line 
1This document is a partial translation of the English README file. The
2original document has much more information, so if you cannot find what
3you need here and can understand a bit of English, try to look at the
4English README file.
5
6For more information, compatibility lists, details on donating, the
7latest release, progress reports and more, please visit the ScummVM home
8page at: https://www.scummvm.org/
9
10Table of Contents:
11------------------
121.0) Introduction
13 * 1.1 About ScummVM
14 * 1.2 Quick start
152.0) Contact
16 * 2.1 Reporting Bugs
17
181.0) Introduction:
19---- -------------
20
211.1) About ScummVM:
22---- --------------
23ScummVM is a program which allows you to run certain classic graphical
24point-and-click adventure games, provided you already have their data
25files. The clever part about this: ScummVM just replaces the executables
26shipped with the game, allowing you to play them on systems for which
27they were never designed!
28
29Originally it was designed to run LucasArts' SCUMM games, such as Maniac
30Mansion, Monkey Island, Day of the Tentacle or Sam and Max. SCUMM stands
31for "Script Creation Utility for Maniac Mansion", which was the first
32game for which LucasArts designed this system. And much later it gave
33its name to ScummVM ('VM' meaning Virtual Machine).
34
35Over time support for a lot of non-SCUMM games has been added, and
36ScummVM now also supports many of Sierra's AGI and SCI games (such as
37King's Quest 1-7, Space Quest 1-6, ...), Discworld 1 and 2, Simon the
38Sorcerer 1 and 2, Beneath A Steel Sky, Lure of the Temptress, Broken
39Sword I and II, Flight of the Amazon Queen, Gobliiins 1-3, The Legend of
40Kyrandia series, many of Humongous Entertainment's children's SCUMM
41games (including Freddi Fish and Putt Putt games) and many more. You can
42find a full list with details on which adventures are supported and how
43well on the compatibility page. ScummVM is continually improving, so
44check back often.
45
46Among the systems on which you can play those games are regular desktop
47computers (running Windows, Linux, Mac OS X, ...), game consoles
48(Dreamcast, Nintendo DS & Wii, PS2, PSP, ...), smartphones (Android,
49iPhone, Symbian ...) and more.
50
51At this time ScummVM is still under heavy development. Be aware that
52whilst we attempt to make sure that many games can be completed with few
53major bugs, crashes can happen and we offer no warranty. That being
54said, some of the games have been supported for a long time and should
55work fine with any recent stable release. You can get a feeling of how
56well each game is working in ScummVM by looking at the compatibility
57page. Actually, if you browse a bit around you might discover that
58ScummVM is even being used commercially to re-release some of the
59supported games on modern platforms. This shows that several companies
60are happy with the quality of the software and how well it can run some
61of the games.
62
63If you enjoy ScummVM feel free to donate using the PayPal button on the
64ScummVM homepage. This will help us buy utilities needed to develop
65ScummVM easier and quicker. If you cannot donate, help and contribute a
66patch!
67
681.2) Quick start:
69---- ------------
70IMPORTANT: This short guide assumes you are using ScummVM in <translated
71language>. By default, ScummVM will use your operating system's
72language. If you prefer to use ScummVM in English, You may also prefer
73to follow the guide from the English REAMDE file.
74
75For the impatient among you, here is how to get ScummVM running in five
76simple steps.
77
781. Download ScummVM from <https://www.scummvm.org/downloads/> and
79 install it.
80
812. Create a directory on your hard drive and copy the game datafiles
82 from the original media to this directory. Repeat this for every
83 game you want to play (it is better to use a separate directory for
84 each game).
85
863. Start ScummVM.
87
88 If at this stage ScummVM appears in English instead of <translated
89 language>, do as follow to change the language:
90 - Click on "Options".
91 - Click on the right arrow in the tab bar and select the "Misc"
92 tab.
93 - Select "<translated language>" in the "GUI Language" box and
94 click on "OK".
95 - Confirm the message box that pops-up, click on "Quit" to quit
96 ScummVM and then restart the program.
97
98 Now choose 'Add game', select the directory with the game datafiles
99 (do not try to select the datafiles themselves!) and press
100 "Choose".
101
1024. A dialog should pop up allowing you to configure various settings if
103 you wish to (it should be just fine to leave everything at its
104 default, though). Confirm the dialog.
105
1065. Select the game you want to play in the list, and press "Start".
107
108In the future, you should be able to directly skip to step 5, unless you
109want to add more games.
110
111Hint: If you want to add multiple games in one go, try pressing and
112holding the shift key before clicking 'Add game' -- its label will
113change to 'Mass Add' and if you press it, you are again asked to select
114a directory, only this time ScummVM will search through all
115subdirectories for supported games.
116
117
1182.0) Contact:
119---- --------
120The easiest way to contact the ScummVM team is by submitting bug reports
121(see section 2.1) or by using our forums at https://forums.scummvm.org .
122You can also join and e-mail the scummvm-devel mailing list, or chat
123with us on IRC (#scummvm on irc.freenode.net) Please do not ask us to
124support an unsupported game -- read the FAQ on our web site first. Note
125that the official language of the forum, mailing list and chat is
126English and no other languages should be used.
127
128
1292.1) Reporting Bugs:
130---- ---------------
131To report a bug, please follow the "Bug Tracker" link from our homepage
132and log in with your GitHub account. Please make sure the bug is
133reproducible, and still occurs in the latest git/Daily build version.
134Also check the known problems list (below) and the compatibility list on
135our website for that game, to ensure the issue is not already known:
136
137 https://www.scummvm.org/compatibility/
138
139Please do not report bugs for games that are not listed as being
140completeable in the 'Supported Games' section, or compatibility list. We
141-know- those games have bugs.
142
143Please include the following information:
144
145 - ScummVM version (PLEASE test the latest git/Daily build)
146 - Bug details, including instructions on reproducing
147 - Language of game (English, German, ...)
148 - Version of game (talkie, floppy, ...)
149 - Platform and Compiler (Win32, Linux, FreeBSD, ...)
150 - Attach a saved game if possible - If this bug only occurred
151 recently, please note the last version without the bug, and the
152 first version including the bug. That way we can fix it quicker by
153 looking at the changes made.
154
155Finally, please report each issue separately; do not file multiple
156issues on the same ticket. (Otherwise, it gets difficult to track the
157status of each individual bug). Please keep also in mind that all the
158bug reports must be written in English.