Skip to content

dwatteau/scummtr

Repository files navigation

ScummTR – Fan translation tools for LucasArts SCUMM games

This project hosts the sources of Thomas Combeleran's fan translation tools for most LucasArts SCUMM engine games, from Maniac Mansion to The Dig.

They are known as scummtr, scummrp, scummfont, and FontXY. They were originally only available as Windows programs, but they're now open-source and available for various systems.

Download

👉 Downloads for various systems are available on the Releases page. It is recommended to always use the latest version.

Note that you need to know how to use a command-line interface in order to use ScummTR, though.

How to use

👉 The FAQ is here to answer the most usual questions. Please read it first if you have any problem.

Some manual pages are also available.

If you have any problem, suggestion or question, feel free to open a discussion or report an issue!

Compiling

If you'd like to compile ScummTR yourself, you will need CMake and a C++98 compatible compiler. It should build on Windows and most POSIX (macOS, Linux, and so on) systems.

mkdir build
cd build
cmake ..
cmake --build .

See also how the official releases are made.

Current goals

The current purpose of this repository is to host the original sources of the ScummTR tools, and provide a simple way of using them on most platforms.

My C++ skills are very modest, and the tools are mostly “done”, so for the moment no big evolution is planned, except for small bug fixes.

However, it is known that the tools currently don't support some game variants, such as Maniac Mansion NES, or Loom TurboGrafx-16. They may become compatible in a future release.

Bug reports, questions and contributions are, of course, very welcome. I suggest having a look at NUTCracker, too; it has a much more modern architecture and is more maintained than ScummTR.

Alternatives and complementary tools

NUTCracker is a more general set of tools, with an emphasis on later SCUMM games (Monkey Island 1 CD and later titles, Humongous Entertainment games), while ScummTR mainly targets translations and supports earlier LucasArts SCUMM games. NUTCracker should also generally be preferred for languages not based on the Latin alphabet.

ScummSpeaks uses ScummTR in order “to assist in adding or replacing speech” to the later SCUMM games. See also ScummPacker, Scummbler and ScummImg from the same author.

Quickandeasysoftware has also been providing extremely nice tools, for years.

License

This project has been licensed under the MIT License in 2020 by its original author, Thomas Combeleran.

Disclaimer

This project is not affiliated in any way with LucasArts Entertainment Company, LucasFilm Ltd, or Humongous Entertainment.

This project is made out of love and respect for the old LucasArts adventure games. LucasArts and Humongous Entertainment games can be bought on wonderful places such as GOG.

This project doesn't contain and doesn't distribute any kind of game data. This project asks all of its users to respect the games, Intellectual Property and Copyright laws.

The purpose of this project is just to help fans make their own fan translations of the games. Fan translations MUST NOT be distributed as a whole game, or with official game data. Fan translations can only be shared through scripts, instructions or patches, and must respect Copyright laws.