scummvm/devtools
Paul Gilbert 1c85b9bcf4 MM: MM1: Better implementation of string uppercasing
All strings in strings_en.yml are now in lowercase for the
enhanced mode. And for original mode, the strings will
simply uppercase them for display
2023-02-01 21:48:04 -08:00
..
create_access DEVTOOLS: Avoid global constructor 2022-01-01 15:25:28 +01:00
create_achievements ACHIEVEMENTS: Generated description files 2022-11-25 07:00:50 +03:00
create_bladerunner DEVTOOLS: BLADERUNNER: Fix packing MIX file for EN_ANY 2023-01-20 19:32:29 +02:00
create_cryo DEVTOOLS: Silence compiler warning 2022-01-01 16:47:12 +01:00
create_cryomni3d DEVTOOLS: Fix Redundant Declaration in Cryomni3d Datafile Tool 2022-03-07 09:15:04 +00:00
create_drascula ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_encoding COMMON: add Korean Johab string encoding 2022-06-13 19:38:47 +02:00
create_engine COMMON: Move achievements.* to engines/ 2022-12-02 00:12:22 +01:00
create_freescape FREESCAPE: added version number information and a basic number check for freescape.dat 2023-01-17 15:00:17 +01:00
create_glk DEVTOOLS: GLK: Fix GCC Compiler Warning From Symbol Conflict 2022-08-27 21:22:04 +01:00
create_hugo ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_kyradat ALL: Make sure str.h is included when using String 2022-10-30 18:37:16 +01:00
create_lure DEVTOOLS: Correct spelling mistake 2022-10-27 15:56:05 +02:00
create_macgui DEVTOOLS: Sync macgui.dat contents 2022-07-16 17:43:35 +02:00
create_macventure MACVENTURE: Include border bitmaps in ScummVM 2016-08-24 11:59:30 +02:00
create_mm MM: MM1: Better implementation of string uppercasing 2023-02-01 21:48:04 -08:00
create_mortdat JANITORIAL: DEVTOOLS: Note Spelling Mistakes 2022-11-15 22:52:43 +02:00
create_myst3 ALL: Cleanup ResidualVM -> ScummVM 2021-12-26 21:19:38 +01:00
create_neverhood DEVTOOLS: Fix Redundant Declaration in Neverhood Datafile Tool 2022-03-07 09:15:04 +00:00
create_pink GRAPHICS: MACGUI: remove pink border, add Win95BorderScrollbar to macgui.dat 2021-04-25 02:24:15 +02:00
create_prince@4e2acb737c DEVTOOLS: Move create_prince to a submodule 2020-06-15 10:54:16 -04:00
create_project CREATE_PROJECT: Add Apple TV OS XCode target 2023-01-29 21:13:51 +00:00
create_supernova SUPERNOVA: Correct spelling mistakes 2022-11-01 17:09:25 +02:00
create_teenagent DEVTOOLS: Correct spelling mistke 2022-10-27 15:56:05 +02:00
create_titanic DEVTOOLS: Fix build after base-str.cpp rename 2023-01-05 17:17:33 +01:00
create_tony ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_toon ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_translations ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_ultima ULTIMA8: Remove the Pentagram default mouse as we never loaded it 2022-12-10 12:23:12 -06:00
extract_mort ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
qtable DEVTOOLS: Replace ugly SDL/MinGW hack with a cleaner hack 2021-08-03 07:35:15 +03:00
sci SCI: add typing to scifx_to_cpp script 2022-07-24 12:01:27 +03:00
skycpt ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
tasmrecover ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
agi-palex.py
construct-pred-dict.pl ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
convbdf.cpp ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
create_japanesemacfonts.sh DEVTOOLS: Make create_japanesemacfonts portable using 7-zip and xar-unpacker 2022-07-15 22:34:09 +02:00
credits.pl CREDITS: Add the seal 2023-01-09 22:30:32 +01:00
dist-scummvm.sh DEVTOOLS: Calculate SHA-256 checksums during tarball creation 2022-07-17 12:21:57 +02:00
docker.sh DEVTOOLS: Add a build script to simplify building with Docker 2021-09-02 13:21:27 +02:00
dumper-companion.py DEVTOOLS: dumper-companion.py: better handle removing null bytes from partition type 2023-01-11 08:38:34 +01:00
extract-words-tok.pl ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
gog_gameid.py DEVTOOLS: Add gameId getting script for GOG Galaxy 2021-05-30 20:49:49 +03:00
make_class.py DEVTOOLS: Improve documentation for make_class.py 2022-08-14 11:00:03 +10:00
make-scumm-fontdata.cpp ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
make-www-archive.py JANITORIAL: Remove trailing whitespaces 2021-05-04 11:46:30 +03:00
md5table.cpp DEVTOOLS: Make C++ the default mode for md5table 2022-07-14 07:44:58 +02:00
module.mk DEVTOOLS: Fixed compilation 2021-11-20 15:03:52 +01:00
README DEVTOOLS: Improve documentation for make_class.py 2022-08-14 11:00:03 +10:00
scumm-md5.txt SCUMM: Add more sizes to detection entries 2022-12-20 18:44:07 +02:00
steam_gameid.py DEVTOOLS: Fix steam_gameid.py for current steamdb format 2021-05-30 20:49:49 +03:00
themeparser.py ALL: Update ScummVM project license to GPLv3+ 2021-12-26 18:48:43 +01:00
update-version.pl TVOS: Add Apple TV OS as a separate dist 2023-01-29 21:13:51 +00:00
xar-unpacker.py DEVTOOLS: Make create_japanesemacfonts portable using 7-zip and xar-unpacker 2022-07-15 22:34:09 +02:00

This directory contains various tools which aid the ScummVM developers
in their work. They are not intended for the general audience, and are
only sparsely, if at all, documented. Use at your own risk. You have
been warned :-).


agi-palex.py (buddha)
------------
    Tool for extracting palettes from Amiga AGI games' executables.


construct-pred-dict.pl, extract-words-tok.pl (sev)
--------------------------------------------
    Tools related to predictive input for AGI engine.


convbdf
-------
    Tool which converts BDF fonts (BDF = Bitmap Distribution Format) to
    C++ source. That source, after being slightly tweaked, can be used to
    replace or add fonts for the ScummVM GUI.

    There is also a ttf2bdf tool which allows you to convert TrueType
    fonts to BDF.

    Hint from SumthinWicked: If you use ttf2bdf, it'll convert all glyphs
    to bitmaps, but ScummVM only needs some of them. So you may want to
    do your conversion like this:
      ttf2bdf -p SIZE -l "32_160" -o FONT.bdf FONT.ttf
    where SIZE is replaced by the desired font height.


create_classicmacfonts.sh, create_japanesemacfonts.sh
_____________________________________________________
    Scripts for extracting fonts from Classic MacOS images freely
    available from apple.com. Used in Director, MacVenture, SCUMM
    and WAGE engines.


create_cryo
-----------
    Creates cryo.dat file which contains a lot of hardcoded tables used
    by the Cryo engine..


create_drascula (sev)
---------------
    Stores a lot of hardcoded data of Drascula in a data file, based on
    the game's original source code. This includes the game's character
    map, item locations, several hardcoded arrays used in animations,
    room script logic, talk sequence logic and all of the game's texts
    (mostly the dialog subtitles) in English, Spanish, German, French
    and Italian. This tool is used to create the drascula.dat file.


create_encodings (phcoder)
--------------
   Transforms CJK tables from unicode consortium format to the format
   used by ScummVM


create_hugo (Strangerke)
-----------
    Creates hugo.dat file which contains all kinds of static data contained
    in original game executable.


create_kyradat (LordHoto, athrxx)
--------------
    Extracts various static data from the original game executables.
    This includes room tables in kyra1, various hardcoded language
    strings in both kyra1 and kyra2, script data for the sequence
    players of kyra1 and kyra2 and other static data. This tool is used
    to create the kyra.dat file.


create_lure (dreammaster)
-----------
    Extracts various static data from each of the different language
    versions of the game executables. This includes character
    animations, game scripts, and other static data. This tool creates
    the lure.dat file.


create_mort (Strangerke)
-----------
    Gathers several information found in the original DOS executable:
    - Font data
    - French, German and fan-made English translation


create_project (LordHoto, Littleboy)
--------------
    Creates project files for Visual Studio 2008, 2010, 2012, 2013, 2015,
    Xcode and Code::Blocks out of the configure / Makefile based build system.
    It also offers a way to enable or disable certain engines and the use
    of external libraries similar to configure. Run the tool without
    any arguments for further help.


create_supernova (criezy)
----------------
    Creates supernova.dat files which contains static data contained in the
    original executable as well as translations into additional languages.


create_toon (Strangerke)
-----------
    This tool creates toon.dat, which contains all the game's texts
    hardcoded in original game executable. This includes English, French,
    German, Russian and Spanish texts.


create_translations (criezy)
-------------------
    Creates the translations.dat file from po files given as arguments.
    The generated files is used by ScummVM to propose a translated GUI.


credits.pl
----------
    This perl script contains credits to the many people who helped with
    ScummVM, and it is used to create the credits lists that occur in
    various places, including the AUTHORS file, the about dialog, and our
    web site.


dist-scummvm.sh
---------------
    This shell script is used to create source release archives for
    ScummVM releases. After tagging a branch for release, you can invoke
    it like this:

      ./dist-scummvm.sh scummvm 0.7.1

    Note #1: This creates .zip, .tar.bz2 and .tar.gz archives in /tmp by
    default. To do that it performs a "cvs export" in /tmp first. If you
    want to use another location, you can specify it as the thirds param
    to the script.

    Note #2: This assumes that our naming conventions for release tags
    are being followed. I.e. the tag must be named "release-0-7-1" in
    the above example. You can, however, specify an alternate tag as the
    fourth param.

    Note #3: Since SF.net anon CVS tends to lag behind developer CVS, if
    you just tagged CVS, anon CVS may not yet have this. So if you are
    in a hurry, modify the cvsroot in the script to use your dev CVS
    account.


docker.sh
---------
    This shell script is used to simplify building with the Docker images
    used by the buildbot. It can invoked like this:

      ./devtools/docker.sh toolchain/mxe

    This will fetch the MXE toolchain from the Docker Hub if it hasn't
    already and launch a shell that can be used to build ScummVM for
    Windows.


dumper_companion.py
___________________
    Tool for dumping HFS/HFS+ volumes and game files with non-ASCII
    characters in names. Full documentation could be found at
    https://wiki.scummvm.org/index.php?title=HOWTO-Dump_Macintosh_Media


gog_gameid.py, steam_gameid.py
______________________________
    Tools for obtaining gameids from GOG and Steam used when preparing the
    Achievements lists.


make_class.py
-------------------
    Tool that adds all the boilerplate for a new C++ class inside an engine
	Examples:

	$ make_class.py scumm . LeChuck
	Make new class `LeChuck` in the scumm engine root (engines/scumm/).
	Creates boilerplate class Scumm::LeChuck, in le_chuck.cpp and le_chuck.h
	(files are lower-cased, upper-case letters from class name get '_' added).
	Adds corresponding .o file to module.mk list.

	$ make_class.py -n BladeRunner bladerunner ui Scores
	Make a new class BladeRunner::Scores in the engines/bladerunner/ui/
	directory.


make-scumm-fontdata (eriktorbjorn)
-------------------
    Tool that generates compressed font data used in SCUMM: To get rid of
    a few kilobytes of hard-coded font data, we only store how the
    French, German, Italian and Spanish fonts differ from the English one.


make-www-archive.py
___________________
    Tool for creating wwwroot.zip used by the Local Server cloud feature.


md5table
--------
    Used to convert scumm-md5.txt into a SCUMM header file, or
    alternatively PHP code for our website.


qtable (cyx)
-------
    This tool generates the "queen.tbl" file.


skycpt (lavosspawn)
-------
    This tool generates the "SKY.CPT" file.