Difference between revisions of "How to guides"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Adds link to new user docs, removes reference to user manual. Tidies up page and removes information now in new docs)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
===Documentation:===
== For end users ==
 
* [https://docs.scummvm.org/ User documentation]
 
* A list of [[datafiles]] required to run games in ScummVM.
* Information for [[Compiling ScummVM]].
* A list of [[International Game Titles]].
* A list of the [[Boot Params]] available for some games.
*[[Copyright FAQ]] explains our hard stance on copying game data without buying it, abandonware, warez and similar things.
* A guide on submitting [[Screenshots]] for use on our game wiki pages.
 
===How to:===
 
* How to extract the Loom PC-Engine/TG16 data track to use with ScummVM [[HOWTO-LoomTG16 |LoomTG16 HOWTO]]
* How to extract the Loom PC-Engine/TG16 data track to use with ScummVM [[HOWTO-LoomTG16 |LoomTG16 HOWTO]]
* How to create an FM-Towns font rom(FMT_FNT.ROM) using a Windows font [[HOWTO-FMT_FNT |FM-Towns Font Rom HOWTO]]
* How to create an FM-Towns font rom(FMT_FNT.ROM) using a Windows font [[HOWTO-FMT_FNT |FM-Towns Font Rom HOWTO]]
* How to translate the ScummVM GUI [[HOWTO-Translate_ScummVM_GUI |Translation HOWTO]]
* How to translate the ScummVM GUI [[HOWTO-Translate_ScummVM_GUI |Translation HOWTO]]
* How to translate the ScummVM Web site [[HOWTO-Translate ScummVM Web Site | Translate ScummVM Web Site HOWTO]]
* How to create a game to run in ScummVM [[HOWTO-Fangames | Fangames HOWTO]]
* How to create a game to run in ScummVM [[HOWTO-Fangames | Fangames HOWTO]]
* How to rip off PlayStation videos [[HOWTO-PlayStation Videos | PlayStation Video HOWTO]]
* How to extract [[The Journeyman Project: Pegasus Prime]] game [[HOWTO-Extract Pegasus Prime | Extract Pegasus Prime HOWTO]]
* How to download for other OS from Steam [[Download_for_other_OS_from_Steam_HOWTO | Download for other OS from Steam HOWTO]]
== For developers ==
=== General ===
* How to release ScummVM [[HOWTO-Release | Release HOWTO]]
* How to use static analysis tools [[HOWTO-Static_Analysis_Tools | Static Analysis Tools HOWTO]]
* How to perform certain admin and moderation tasks [[HOWTO-Admin | Admin HOWTO]]
* How to use GUI Translations in code [[Supporting GUI Translation]]
=== Games/Engines ===
* How to reverse engineer a game [[HOWTO-Reverse Engineering | Reverse Engineering HOWTO]]
* How to create an engine for the ScummVM [[HOWTO-Engines | Engines HOWTO]]
* How to write a better engine for ScummVM [[HOWTO-Tips And Tricks | Tips And Tricks HOWTO]]
* How to debug endianness issues [[HOWTO-Debug-Endian-Issues | Debug Endian Issue HOWTO]]
* How to work with files in ScummVM OSystem [[HOWTO-Open Files | Open Files HOWTO]]
* How to convert plugins if your engine code is before October'20 [[HOWTO-Convert-Plugins | Convert Plugins HOWTO]]
* How to include your engine to ScummVM [[HOWTO-Engine_Inclusion | Engine Inclusion HOWTO]]
* How to announce engine/game release [[HOWTO-Engine Release | Engine Release HOWTO]]
=== Backends ===
* How to develop a new backend [[HOWTO-Backends | Backends HOWTO]]
* How to add support for dynamic plugins in your backend [[HOWTO-Dynamic Modules | Dynamic Modules HOWTO]]

Latest revision as of 13:13, 7 March 2023

For end users

For developers

General

Games/Engines

Backends