eXo Wiki - User contributions [en]

Texts.txt

2022-04-11T07:19:03Z

Timber: bugfix (line0020 and line0023)

'''eXo/util/Launch.bat'''
[[File:Launch.bat (1).png|thumb|386x386px]]
line0001=Game has not been installed

line0002=Would you like to install the game?

'''eXo/util/install.bat'''

line0003=Uninstall?

[[File:Install.bat (2).png|thumb|462x462px]]
line0004=Your current global config settings are:

line0005=Would you like to change any of these?

line0006=YN

line0007=[Y]es or [N]o?

[[File:Install.bat (3).png|thumb|456x456px]]
line0008=Would you like to change your graphics filter?

[[File:Install.bat (4).png|thumb]]

line0009=Press

line0010=for no scaler

'''eXo/emulators/dosbox/config.bat'''
[[File:Config.bat (0).png|thumb|464x464px]]
line0011=FW

line0012=Would you like [F]ullscreen or [W]indowed mode to be the default setting?

[[File:Config.bat (1).png|thumb|428x428px]]
line0013=What is your primary desktop resolution?

line0014=[L]arge (4k)

line0015=[M]edium (1080)

line0016=[S]mall (less than 1080)

line0017=LMS

[[File:Config.bat (2).png|thumb|727x727px]]
line0018=Would you like to enable Aspect Correction for all games?

line0019=Choosing Yes will attempt to preserve the game's original format. In fullscreen

line0020=mode this will introduce black bars on the sides.

line0021=Choosing No will stretch the image to fit your monitor.

line0022=Choosing 'Yes' is useful for widescreen monitors which cause stretching

line0023=or distortion.

'''eXo/eXoDOS/!dos/<gamefolder>/Extras/Alternate Launcher.bat'''
[[File:Alternate Launcher (1).png|thumb|607x607px]]
line0024=to Quit

line0025=Please note, all of the above options are experimental and

line0026=use non-optimized versions of DOSBox.

line0027=Pixel Perfect attempts to properly emulate pixel ratio

line0028=Curved CRT emulates the effects of a CRT monitor

line0029=No Scan Line Mode removes scan lines from select FMV games

line0030=Please Choose:

[[File:Alternate Launcher (2).png|thumb|589x589px]]

line0031=You have selected to play with Pixel Perfect mode.

line0032=This warning\explanation will only appears once.

line0033=Further info can be found in the read me file.

line0034=Pixel Perfect mode emulates the pixel ratio

line0035=of DOS Games as accurately as can be managed

line0036=with DOSBox, however it is not compatible with

line0037=all games and may cause issues - in some cases

line0038=making the game unplayable. If this happens

line0039=restart the game using the standard launch method.

line0040=Other potential benefits of choosing this

line0041=mode is that in some cases DOSBox will be

line0042=using a more accurate OPL Audio emulation

line0043=[nuked OPL] and have more accurate PC Speaker

line0044=emulation.

Texts.txt

2022-04-05T20:50:23Z

Timber: creation

'''eXo/util/Launch.bat'''
[[File:Launch.bat (1).png|thumb|386x386px]]
line0001=Game has not been installed

line0002=Would you like to install the game?

'''eXo/util/install.bat'''

line0003=Uninstall?

[[File:Install.bat (2).png|thumb|462x462px]]
line0004=Your current global config settings are:

line0005=Would you like to change any of these?

line0006=YN

line0007=[Y]es or [N]o?

[[File:Install.bat (3).png|thumb|456x456px]]
line0008=Would you like to change your graphics filter?

[[File:Install.bat (4).png|thumb]]

line0009=Press

line0010=for no scaler

'''eXo/emulators/dosbox/config.bat'''
[[File:Config.bat (0).png|thumb|464x464px]]
line0011=FW

line0012=Would you like [F]ullscreen or [W]indowed mode to be the default setting?

[[File:Config.bat (1).png|thumb|428x428px]]
line0013=What is your primary desktop resolution?

line0014=[L]arge (4k)

line0015=[M]edium (1080)

line0016=[S]mall (less than 1080)

line0017=LMS

[[File:Config.bat (2).png|thumb|727x727px]]
line0018=Would you like to enable Aspect Correction for all games?

line0019=Choosing Yes will attempt to preserve the game's original format. In fullscreen

line0020=mode this will introduce black bars on the sides..

line0021=Choosing No will stretch the image to fit your monitor.

line0022=Choosing 'Yes' is useful for widescreen monitors which cause stretching or distortion.

line0023=

'''eXo/eXoDOS/!dos/<gamefolder>/Extras/Alternate Launcher.bat'''
[[File:Alternate Launcher (1).png|thumb|607x607px]]
line0024=to Quit

line0025=Please note, all of the above options are experimental and

line0026=use non-optimized versions of DOSBox.

line0027=Pixel Perfect attempts to properly emulate pixel ratio

line0028=Curved CRT emulates the effects of a CRT monitor

line0029=No Scan Line Mode removes scan lines from select FMV games

line0030=Please Choose:

[[File:Alternate Launcher (2).png|thumb|589x589px]]

line0031=You have selected to play with Pixel Perfect mode.

line0032=This warning\explanation will only appears once.

line0033=Further info can be found in the read me file.

line0034=Pixel Perfect mode emulates the pixel ratio

line0035=of DOS Games as accurately as can be managed

line0036=with DOSBox, however it is not compatible with

line0037=all games and may cause issues - in some cases

line0038=making the game unplayable. If this happens

line0039=restart the game using the standard launch method.

line0040=Other potential benefits of choosing this

line0041=mode is that in some cases DOSBox will be

line0042=using a more accurate OPL Audio emulation

line0043=[nuked OPL] and have more accurate PC Speaker

line0044=emulation.

File:Install.bat (4).png

2022-04-05T20:49:57Z

Timber:

install.bat (4)

File:Install.bat (3).png

2022-04-05T20:48:56Z

Timber:

install.bat (3)

File:Install.bat (2).png

2022-04-05T20:48:13Z

Timber:

install.bat (2)

File:Launch.bat (1).png

2022-04-05T20:44:14Z

Timber:

Launch.bat (1)

File:Config.bat (0).png

2022-04-05T20:42:19Z

Timber:

config.bat (0)

File:Config.bat (2).png

2022-04-05T20:40:14Z

Timber:

config.bat (2)

File:Config.bat (1).png

2022-04-05T20:39:23Z

Timber:

config.bat (1)

File:Alternate Launcher (2).png

2022-04-05T20:37:55Z

Timber:

Alternate Launcher (2)

File:Alternate Launcher (1).png

2022-04-05T20:36:25Z

Timber:

Alternate Launcher (1)

The Language Pack Concept

2022-04-05T20:18:56Z

Timber: /* eXo\util\!french */

<div style="float:right;margin-left:40px">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized
**[[Install.bat (language pack)|install.bat]]
**game name (YEAR).bat
**dosbox.conf
**exception.bat (optional)

* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
**[[texts.txt]] (language text lines)
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)
**IP.bat (the batch that sets the IP txt files if the game supports multiplayer)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* [[Install.bat (language pack)|Install.bat]] (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

Install.bat (language pack)

2021-11-12T23:25:15Z

Timber:

eXo created a special install.bat for the language packs

Eulisker and Timber translated the text-strings in this file for the [[German Language Pack|German Language Pack (GLP)]]
===Special info about the file:===
To allow the language pack to use the original eXoDOS-Base pack files if the game is already as a multilingual version in eXoDOS, we added some lines to the install.bat.

we added between
cd ..
and
IF EXIST ".\eXoDOS\%LangDir%\%GameDir%\" GOTO dele
this:
for /F "delims=" %%a in ('findstr /C:"%GameName%" .\util\!german\multilanguage.txt') do (set mla=yes)
and between
:unzip
and
IF NOT EXIST "exodos\%LangDir%\%GameName%.zip" goto exit
this:
if not defined %mla goto nomla
IF NOT EXIST "exodos\%GameName%.zip" goto exit
copy ".\eXoDOS\%GameName%.zip" ".\eXoDOS\%LangDir%\%GameName%.zip"
:nomla
It is needed to let the install.bat check the "multilanguage.txt" file, if the "Gamename (YEAR)" is listed inside the file.

If so, it copies the Gamename (YEAR).zip from the eXoDOS base package to the language pack folder

If not, it simply skips this steps and continues with the next step to unzip the Gamename (YEAR).zip

And between
rd /q /s ".\eXoDOS\%LangDir%\%GameDir%\"
and
:end
we added this:
if not defined %mla goto end
del ".\eXoDOS\%LangDir%\%GameName%.zip"
This is needed to delete the Gamename (YEAR).zip we've copied in the first step

Install.bat (language pack)

2021-11-12T17:44:29Z

Timber: Created page with "eXo created a special install.bat for the language packs Eulisker and Timber translated the text-strings in this file ===Special info about the file:=== To allow the language..."

eXo created a special install.bat for the language packs

Eulisker and Timber translated the text-strings in this file
===Special info about the file:===
To allow the language pack to use the original eXoDOS-Base pack files if the game is already as a multilingual version in eXoDOS, we added some lines to the install.bat.

we added between
cd ..
and
IF EXIST ".\eXoDOS\%LangDir%\%GameDir%\" GOTO dele
this:
for /F "delims=" %%a in ('findstr /C:"%GameName%" .\util\!german\multilanguage.txt') do (set mla=yes)
and between
:unzip
and
IF NOT EXIST "exodos\%LangDir%\%GameName%.zip" goto exit
this:
if not defined %mla goto nomla
IF NOT EXIST "exodos\%GameName%.zip" goto exit
copy ".\eXoDOS\%GameName%.zip" ".\eXoDOS\%LangDir%\%GameName%.zip"
:nomla
It is needed to let the install.bat check the "multilanguage.txt" file, if the "Gamename (YEAR)" is listed inside the file.

If so, it copies the Gamename (YEAR).zip from the eXoDOS base package to the language pack folder

If not, it simply skips this steps and continues with the next step to unzip the Gamename (YEAR).zip

And between
rd /q /s ".\eXoDOS\%LangDir%\%GameDir%\"
and
:end
we added this:
if not defined %mla goto end
del ".\eXoDOS\%LangDir%\%GameName%.zip"
This is needed to delete the Gamename (YEAR).zip we've copied in the first step

The Language Pack Concept

2021-11-12T17:44:12Z

Timber: /* eXo\eXoDOS\!dos\!french */

<div style="float:right;margin-left:40px">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized
**[[Install.bat (language pack)|install.bat]]
**game name (YEAR).bat
**dosbox.conf
**exception.bat (optional)

* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)
**IP.bat (the batch that sets the IP txt files if the game supports multiplayer)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* [[Install.bat (language pack)|Install.bat]] (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

Install.bat

2021-11-12T17:43:16Z

Timber: Blanked the page

Install.bat

2021-11-12T17:32:02Z

Timber: /* Special info about the file: */

eXo created a special install.bat for the language packs

Eulisker and Timber translated the text-strings in this file

=== Special info about the file: ===
To allow the language pack to use the original eXoDOS-Base pack files if the game is already as a multilingual version in eXoDOS, we added some lines to the install.bat.

we added between
cd ..
and
IF EXIST ".\eXoDOS\%LangDir%\%GameDir%\" GOTO dele
this:
for /F "delims=" %%a in ('findstr /C:"%GameName%" .\util\!german\multilanguage.txt') do (set mla=yes)
and between
:unzip
and
IF NOT EXIST "exodos\%LangDir%\%GameName%.zip" goto exit
this:
if not defined %mla goto nomla
IF NOT EXIST "exodos\%GameName%.zip" goto exit
copy ".\eXoDOS\%GameName%.zip" ".\eXoDOS\%LangDir%\%GameName%.zip"
:nomla
It is needed to let the install.bat check the "multilanguage.txt" file, if the "Gamename (YEAR)" is listed inside the file.

If so, it copies the Gamename (YEAR).zip from the eXoDOS base package to the language pack folder

If not, it simply skips this steps and continues with the next step to unzip the Gamename (YEAR).zip

And between
rd /q /s ".\eXoDOS\%LangDir%\%GameDir%\"
and
:end
we added this:
if not defined %mla goto end
del ".\eXoDOS\%LangDir%\%GameName%.zip"
This is needed to delete the Gamename (YEAR).zip we've copied in the first step

Install.bat

2021-11-12T17:30:01Z

Timber: /* Special info about the file: */

eXo created a special install.bat for the language packs

Eulisker and Timber translated the text-strings in this file

=== Special info about the file: ===
To allow the language pack to use the original eXoDOS-Base pack files if the game is already as a multilingual version in eXoDOS, we added some lines to the install.bat.

we added between
cd ..
and
IF EXIST ".\eXoDOS\%LangDir%\%GameDir%\" GOTO dele
this:
for /F "delims=" %%a in ('findstr /C:"%GameName%" .\util\!german\multilanguage.txt') do (set mla=yes)
and between
:unzip
and
IF NOT EXIST "exodos\%LangDir%\%GameName%.zip" goto exit
this:
if not defined %mla goto nomla
IF NOT EXIST "exodos\%GameName%.zip" goto exit
copy ".\eXoDOS\%GameName%.zip" ".\eXoDOS\%LangDir%\%GameName%.zip"
:nomla
It is needed to let the install.bat check the "multilanguage.txt" file, if the "Gamename (YEAR)" is listed inside the file.

If so, it copies the Gamename (YEAR).zip from the eXoDOS base package to the language pack folder

If not, it simply skips this steps and continues with the next step to unzip the Gamename (YEAR).zip

And between
rd /q /s ".\eXoDOS\%LangDir%\%GameDir%\"
and
:end
we added this:
if not defined %mla goto end
del .\eXoDOS\%LangDir%\%GameName%.zip
This is needed to delete the Gamename (YEAR).zip we've copied in the first step

Install.bat

2021-11-12T17:25:36Z

Timber: Created page with "eXo created a special install.bat for the language packs Eulisker and Timber translated the text-strings in this file === Special info about the file: === To allow the langu..."

eXo created a special install.bat for the language packs

Eulisker and Timber translated the text-strings in this file

=== Special info about the file: ===
To allow the language pack to use the original eXoDOS-Base pack files if the game is already as a multilingual version in eXoDOS, we added some lines to the install.bat.

we added between
:unzip
and
IF NOT EXIST "exodos\%LangDir%\%GameName%.zip" goto exit
this:
for /F "delims=" %%a in ('findstr /C:"%GameName%" .\util\!german\multilanguage.txt') do (set mla=yes)
if not defined %mla goto nomla
IF NOT EXIST "exodos\%GameName%.zip" goto exit
copy ".\eXoDOS\%GameName%.zip" ".\eXoDOS\%LangDir%\%GameName%.zip"
:nomla
It is needed to let the install.bat check the "multilanguage.txt" file, if the "Gamename (YEAR)" is listed inside the file.

If so, it copies the Gamename (YEAR).zip from the eXoDOS base package to the language pack folder

If not, it simply skips this steps and continues with the next step to unzip the Gamename (YEAR).zip

And between
rd /q /s ".\eXoDOS\%LangDir%\%GameDir%\"
and
:end
we added this:
if not defined %mla goto end
del .\eXoDOS\%LangDir%\%GameName%.zip
This is needed to delete the Gamename (YEAR).zip we've copied in the first step

The Language Pack Concept

2021-11-12T17:11:24Z

Timber: /* eXo\eXoDOS\!dos\!french */

<div style="float:right;margin-left:40px">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized
**[[install.bat]]
**game name (YEAR).bat
**dosbox.conf
**exception.bat (optional)

* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)
**IP.bat (the batch that sets the IP txt files if the game supports multiplayer)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* [[Install.bat]] (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

Interactive Code Wheels

2021-11-11T17:56:57Z

Timber:

<div style="float:right;margin-left:40px">__TOC__</div>

List of the included and missing code wheels : https://github.com/exoscoriae/eXoDOS/issues/1660

== Pictures of the wheels ==
First you have to have the pictures of the wheels of course. These must be adjusted to a 800x800 pixel image with a transparent background, example from photoshop:
[[File:Codewheels1.png|left|thumb]]

[[File:Codewheels2.png|left|thumb]]

Save them as *.png.
== Convert to base64 ==
Convert the pictures to base64, for example using this [https://www.browserling.com/tools/image-to-base64 online tool]. Save the base64-code results for later use.

== HTML edit ==
Copy a [https://github.com/Beylie/WikiTest/files/5113856/codewheeltemplates.zip template] and rename it

either

template_code-wheel-2wheels.HTM (for code wheel with 2 wheels)

or

template_code-wheel-3wheels.HTM (for code wheel with 3 wheels)

Edit the HTM file with any HTML editor (Notepad++ works fine)
2-wheel:

* Lines 5, 6, 7, 520, 521
** change title and name of the game
* Line 385
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 393
** copy the base64-code from (2) for the top-wheel and replace the current base64 code
3-wheel:

* Lines 5, 6, 7, 527, 528
** change title and name of the game
* Line 384
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 392
** copy the base64-code from (2) for the middle-wheel and replace the current base64 code
* Line 400
** copy the base64-code from (2) for the top-wheel and replace the current base64 code

Interactive Code Wheels

2021-11-11T17:56:12Z

Timber:

List of the included and missing code wheels : https://github.com/exoscoriae/eXoDOS/issues/1660

== Pictures of the wheels ==
First you have to have the pictures of the wheels of course. These must be adjusted to a 800x800 pixel image with a transparent background, example from photoshop:
[[File:Codewheels1.png|left|thumb]]

[[File:Codewheels2.png|left|thumb]]

Save them as *.png.
== Convert to base64 ==
Convert the pictures to base64, for example using this [https://www.browserling.com/tools/image-to-base64 online tool]. Save the base64-code results for later use.

== HTML edit ==
Copy a [https://github.com/Beylie/WikiTest/files/5113856/codewheeltemplates.zip template] and rename it

either

template_code-wheel-2wheels.HTM (for code wheel with 2 wheels)

or

template_code-wheel-3wheels.HTM (for code wheel with 3 wheels)

Edit the HTM file with any HTML editor (Notepad++ works fine)
2-wheel:

* Lines 5, 6, 7, 520, 521
** change title and name of the game
* Line 385
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 393
** copy the base64-code from (2) for the top-wheel and replace the current base64 code
3-wheel:

* Lines 5, 6, 7, 527, 528
** change title and name of the game
* Line 384
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 392
** copy the base64-code from (2) for the middle-wheel and replace the current base64 code
* Line 400
** copy the base64-code from (2) for the top-wheel and replace the current base64 code

Interactive Code Wheels

2021-11-11T17:53:17Z

Timber: Created page with "List of the included and missing code wheels : https://github.com/exoscoriae/eXoDOS/issues/1660 == Pictures of the wheels == First you have to have the pictures of the wheels..."

List of the included and missing code wheels : https://github.com/exoscoriae/eXoDOS/issues/1660

== Pictures of the wheels ==
First you have to have the pictures of the wheels of course. These must be adjusted to a 800x800 pixel image with a transparent background, example from photoshop:
[[File:Codewheels1.png|left|thumb]]

[[File:Codewheels2.png|left|thumb]]

Save them as *.png.

== Convert to base64 ==
Convert the pictures to base64, for example using this [https://www.browserling.com/tools/image-to-base64 online tool]. Save the base64-code results for later use.

== HTML edit ==
Copy a [https://github.com/Beylie/WikiTest/files/5113856/codewheeltemplates.zip template] and rename it

either

template_code-wheel-2wheels.HTM (for code wheel with 2 wheels)

or

template_code-wheel-3wheels.HTM (for code wheel with 3 wheels)

Edit the HTM file with any HTML editor (Notepad++ works fine)
2-wheel:

* Lines 5, 6, 7, 520, 521
** change title and name of the game
* Line 385
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 393
** copy the base64-code from (2) for the top-wheel and replace the current base64 code
3-wheel:

* Lines 5, 6, 7, 527, 528
** change title and name of the game
* Line 384
** copy the base64-code from (2) for the background-wheel and replace the current base64 code
* Line 392
** copy the base64-code from (2) for the middle-wheel and replace the current base64 code
* Line 400
** copy the base64-code from (2) for the top-wheel and replace the current base64 code

File:Codewheels2.png

2021-11-11T17:49:04Z

Timber: Interactive code wheels creation 2

== Summary ==
Interactive code wheels creation 2

File:Codewheels1.png

2021-11-11T17:48:19Z

Timber: Interactive code wheels creation 1

== Summary ==
Interactive code wheels creation 1

Main Page

2021-11-11T17:44:41Z

Timber: /* Metadata */ added Interactive Code Wheels link

= <div style="text-align:center;">[[File:RetroeXo Logo.png]] '''Retro eXo'''</div> =
Project Goal 
The eXo projects' goal is preservation through playability. 

Project Resources 
'''[http://www.retro-exo.com www.retro-exo.com]''': Project Homepage. 
'''[https://www.youtube.com/c/eXoRetro YouTube Channel]''': Various videos about the project and how to use it. 
'''[https://discord.gg/37FYaUZ Discord]''': Project discussion, chat, & community. 
'''[https://github.com/exoscoriae/ Github]''': Bugs, submissions, and enhancements are tracked here. 

== Projects ==

=== Current ===
==== [[EXODOS]] ====
Current Version: eXoDOS v5 
Release Date: October 31st, 2020 
Number of Games: 7,200 
Upcoming Version: eXoDOS v6, ETA 2022 
 
==== [[EXOWin3x]] ====
Current Version: eXoWin3x v2 
Release Date: February 14th, 2021 
Number of Games: 1,138 
Upcoming Version: eXoWin3x v3, ETA 2022 
 
==== [[EXOScummVM]] ====
Current Version: eXoScummVM r2.2.0 
Release Date: June 20th, 2021 
Number of Games: 387 unique titles, multiple variations of each 
Upcoming Version: TBD 
 
==== [[EXORLP]] ====
Current Version: eXo's Retro Learning Pack 
Release Date: April 1st, 2020 
Number of Games: 667 titles, compiled from eXoDOS and eXoWin3x 
Upcoming Version: None. RLP Was a one time release. Upon merging eXoDOS and eXoWin3x however, a playlist appears that allows you to select all games that were originally included in the RLP 
 

=== Future ===
==== EXOWin9x ====
Current Version: None 
Release Date: ? 
Number of Games: ? 
Upcoming Version: ETA Unknown. Depends on progress in emulation 
 
==== Secret ====
Current Version: None 
Release Date: ? 
Number of Games: ? 
Upcoming Version: ETA 2022 
 

== History ==

The eXo projects originated from wanting to sit down and play MS-DOS games without spending hours trying to get them running. Games such as DiscWorld were notoriously difficult and had a fair number of forum posts and websites dedicated to attempts to get them running. However websites centered on the topic of DOSBox, the primary MS-DOS emulator, were generally less than welcoming. eXo's original goal was to get his collection of MS-DOS Adventure games setup in a front end and easily accessible. Posts regarding this project began to appear on Underground Gamer & Pleasuredome in 2007, eventually leading to the release of eXoDOS Vol. I: Adventure in early 2008. This first release had around 650 titles in it, with plans to continue on to a second volume dedicated to role-playing games after excitement was expressed by fellow members on Underground Gamer. It was during this time that eXo became concerned that the nature of DOS emulation was leading towards a scenario in which the number of people who had the technical knowledge to set games up on their own was dwindling. Meanwhile, only a handful of highly popular commercial games for the era were available on any store front. eXo decided to continue tackling volumes of games with the impossible goal of preserving all MS-DOS games. Fundamental changes to the structure of the project were made leading to the release of eXoDOS Version 2. Vol. I-II were re-released along with eXoDOS Vol. III: Strategy (2009). Some of these primary changes included moving the games conf files out of their archive and into the same folder as the launcher. This allowed the conf file to be modified without the need to repack the entire game. eXoDOS Vol. IV: Sim\Sports\Racing\Educational (2011) and eXoDOS Vol. V: Action (2012) were released using the same structure. Releases were originally split into volumes due to bandwidth and storage concerns, however it also helped to focus work on specific packs. 
Work on the first 2 versions of eXoDOS was primarily manual. Games were originally identified by hand typing metadata from [https://www.mobygames.com/ MobyGames] into a database. Each game's launcher, conf file, and install file was copied from a base template and then modified to fit that game, with information like folder names, game name, and other variables hard coded. Soon after the release of eXoDOS Version 2, eXo began to work on a Windows 3x project. This was a very slow process due to the rocky documentation and emulation of Windows 3x. Several improvements were made to the structure of the project during this time however, leading the the release of eXoDOS Version 3. The Windows 3x project was dubbed Win3xO, and released in 2015 with just over 1,000 games in it. eXoDOS versions 1-3 and Win3xO were powered by the [https://sites.google.com/site/meagrefrontend/ MEAGRE] front end, which was also originally posted as a member project on the UG forums. 
The release of Win3xO led to serious burnout, which resulted in a year long break in the project that coincided with the abrupt deletion of Underground Gamer's website, tracker, and forums. Eventually eXo began work on locating new games for the DOS project while addressing bug fixes within the Windows 3x project. Work continued alone during this time, however with the downfall of UG, discussion at this point was primarily limited to occasional posts on the Pleasuredome forums. During this time the author of MEAGRE, Donarumo, decided to cease development on the front end. He moved his personal collections over to [https://www.launchbox-app.com/ LaunchBox] and encouraged eXo to consider it for his projects as well. After a positive discussion with the author of LaunchBox, permission was granted to include it with the forthcoming eXoDOS Version 4 release. Changing to a new front end was a massive task however, as it meant that all metadata (release information, manuals, game images, etc...) had to be imported on a game by game basis. This time was used to begin scrubbing the project of all images that had watermarks, and replacing them with original screen shots and clean box scans. 
In response to the decline of participation of forums, a [https://discord.com/ Discord] server was started for the project on June 7th, 2018. The community quickly grew with various people who had been following the project for years. The ability to communicate in real time allowed others to find ways to contribute, which quickly led to the formation of the "eXoSquad". This led to a flood of improvements for eXoDOS Version 4, with one of the primary new features being the ability to select advanced sound card options. Since then, a steady flow of new features and improved modules have been created for each upcoming release. 
In March of 2020, in response the quarantine protocols and school closings, the RLP (Retro Learning Pack) was released. This pack of 667 games from the MS-DOS and Windows 3.x era was designed to give parents of children stuck at home a way to entertain and educate their children during lockdown. [https://kotaku.com/loads-of-awesome-old-pc-games-will-keep-your-damn-kids-1842632937 Coverage] of the pack extended into the media on sites like [https://kotaku.com/ Kotaku].

== Media ==

The project and/or creator have been featured in the following articles:

[https://blog.archive.org/2019/10/13/2500-more-ms-dos-games-playable-at-the-archive/ ''2,500 More MS-DOS Games Playable at the Archive.'' Scott, J. (2019, Oct. 13). Internet Archive Blog] 
[https://kotaku.com/one-mans-quest-to-collect-every-classic-pc-game-in-exis-1839432488 ''One Man's Quest To Collect Every Classic PC Game In Existence.'' Plunkett, L. (2019, Dec. 16). Kotaku.] 
[https://kotaku.com/loads-of-awesome-old-pc-games-will-keep-your-damn-kids-1842632937 ''Loads Of Awesome Old PC Games Will Keep Your Damn Kids Busy'' Plunkett, L. (2020, Apr. 4). Kotaku] 

== Technical Information ==

=== Emulated Hardware ===
[[3Dfx]] 
[[Sound Cards]] 
[[Video Modes]] 
[[Remote Multiplayer]] 

=== Common Core Systems ===

[[Project Setup]] 
[[Installer]] 
[[Launcher]] 
[[DOSBox Configuration File]] 
[[Updater]] 
[[Downloader]] 
[[EXO Plugin]] 

==== Emulators ====
[[DOSBox]] 
[https://wiki.scummvm.org/index.php?title=Main_Page ScummVM] 

=== Metadata ===

[[Images]] 
[[LaunchBox Platform XML]] 
[[Manuals]] 
[[Magazines]] 
[[Music]] 
[[Playlists]] 
[[Video Snaps]] 
[[Interactive Code Wheels]]

=== Database ===

[[Master Database]] 

== Language Packs ==

[[The Language Pack Concept]]

==== In Progress: ====
[[French Language Pack]] 
[[German Language Pack]] 

==== On Hold: ====
Polish Language Pack 

==== In need of a curator ====
Chinese Language Pack 
Italian Language Pack 
Korean Language Pack 
Russian Language Pack 
Spanish Language Pack 
 
If you have any interest in assisting with these language packs (or working on an unlisted language pack), please join our [https://discord.gg/37FYaUZ Discord] server.

== FAQ ==
For a list of frequently asked questions, please visit the [https://www.retro-exo.com/FAQ.html website FAQ].

== Contact ==

If you would like to contribute, please contact [[User:EXO|EXO]] for registration.

The Language Pack Concept

2021-11-09T22:23:46Z

Timber: /* eXo\util\!french */

<div style="float:right;margin-left:40px">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized install batch, game launch batch,
dosbox.conf, exception batch (optional)
* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)
**IP.bat (the batch that sets the IP txt files if the game supports multiplayer)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* Install.bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

German Language Pack

2021-11-08T11:50:14Z

Timber: /* Overview */

<div style="float:right;margin-left:40px">__TOC__</div>

== Overview ==

English: 
The German language pack (short: GLP) is an addon for eXoDOS (beginning with v6).
It is currently under developement, version 1.0 will be released in 2022.

Admins for the GLP are Timber and Eulisker.

The GLP games list can be found here: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

German: 
Der "German language pack" (kurz: GLP) ist ein Add-on für eXoDOS (ab der Version v6).
Er befindet sich derzeit noch in der Entwicklung/Zusammenstellung, die Version 1.0 wird voraussichtlich in 2022 zusammen mit eXoDOS Version 6 veröffentlicht.

Admins für den GLP sind Timber und Eulisker

Die aktuelle Spiele-Liste für den GLP findet man hier: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

== Roadmap ==

* MS 0: Vorbereitungen abgeschlossen, Framework steht
* MS 1: 50 Spiele
* MS 2: 100 Spiele
* MS 3: 200 Spiele
* MS 4: 300+ Spiele (angepeilt für Ende 2021), danach interne Testphase
* MS 5: interne Testphase abgeschlossen, externe beginnt
* MS 6: externe Testphase abgeschlossen
* MS 7: Packaging GLP v1
* MS 8: Release GLP v1 (zeitgleich mit eXoDOS v6)

German Language Pack

2021-11-08T11:49:08Z

Timber: /* Overview */

<div style="float:right;margin-left:40px">__TOC__</div>

== Overview ==

English: 
The German language pack (short: GLP) is an addon for eXoDOS (beginning with v6).
It is currently under developement, version 1.0 will be released in 2022.

The GLP games list can be found here: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

German: 
Der "German language pack" (kurz: GLP) ist ein Add-on für eXoDOS (ab der Version v6).
Er befindet sich derzeit noch in der Entwicklung/Zusammenstellung, die Version 1.0 wird voraussichtlich in 2022 zusammen mit eXoDOS Version 6 veröffentlicht.

Die aktuelle Spiele-Liste für den GLP findet man hier: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

== Roadmap ==

* MS 0: Vorbereitungen abgeschlossen, Framework steht
* MS 1: 50 Spiele
* MS 2: 100 Spiele
* MS 3: 200 Spiele
* MS 4: 300+ Spiele (angepeilt für Ende 2021), danach interne Testphase
* MS 5: interne Testphase abgeschlossen, externe beginnt
* MS 6: externe Testphase abgeschlossen
* MS 7: Packaging GLP v1
* MS 8: Release GLP v1 (zeitgleich mit eXoDOS v6)

German Language Pack

2021-11-08T11:48:51Z

Timber: /* Overview */

<div style="float:right;margin-left:40px">__TOC__</div>

== Overview ==

English:
The German language pack (short: GLP) is an addon for eXoDOS (beginning with v6).
It is currently under developement, version 1.0 will be released in 2022.

The GLP games list can be found here: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

German:
Der "German language pack" (kurz: GLP) ist ein Add-on für eXoDOS (ab der Version v6).
Er befindet sich derzeit noch in der Entwicklung/Zusammenstellung, die Version 1.0 wird voraussichtlich in 2022 zusammen mit eXoDOS Version 6 veröffentlicht.

Die aktuelle Spiele-Liste für den GLP findet man hier: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

== Roadmap ==

* MS 0: Vorbereitungen abgeschlossen, Framework steht
* MS 1: 50 Spiele
* MS 2: 100 Spiele
* MS 3: 200 Spiele
* MS 4: 300+ Spiele (angepeilt für Ende 2021), danach interne Testphase
* MS 5: interne Testphase abgeschlossen, externe beginnt
* MS 6: externe Testphase abgeschlossen
* MS 7: Packaging GLP v1
* MS 8: Release GLP v1 (zeitgleich mit eXoDOS v6)

German Language Pack

2021-11-08T11:46:48Z

Timber: /* Roadmap */

<div style="float:right;margin-left:40px">__TOC__</div>

== Overview ==

The German language pack (short: GLP) is an addon for eXoDOS (beginning with v6).
It is currently under developement, version 1.0 will be released in 2022.

The GLP games list can be found here: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

== Roadmap ==

* MS 0: Vorbereitungen abgeschlossen, Framework steht
* MS 1: 50 Spiele
* MS 2: 100 Spiele
* MS 3: 200 Spiele
* MS 4: 300+ Spiele (angepeilt für Ende 2021), danach interne Testphase
* MS 5: interne Testphase abgeschlossen, externe beginnt
* MS 6: externe Testphase abgeschlossen
* MS 7: Packaging GLP v1
* MS 8: Release GLP v1 (zeitgleich mit eXoDOS v6)

German Language Pack

2021-11-08T11:45:54Z

Timber:

<div style="float:right;margin-left:40px">__TOC__</div>

== Overview ==

The German language pack (short: GLP) is an addon for eXoDOS (beginning with v6).
It is currently under developement, version 1.0 will be released in 2022.

The GLP games list can be found here: https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA

== Roadmap ==

MS 0: Vorbereitungen abgeschlossen, Framework steht
MS 1: 50 Spiele
MS 2: 100 Spiele
MS 3: 200 Spiele
MS 4: 300+ Spiele (angepeilt für Ende 2021), danach interne Testphase
MS 5: interne Testphase abgeschlossen, externe beginnt
MS 6: externe Testphase abgeschlossen
MS 7: Packaging GLP v1
MS 8: Release GLP v1 (zeitgleich mit eXoDOS v6)

The Language Pack Concept

2021-11-08T11:15:09Z

Timber:

<div style="float:right;margin-left:40px">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized install batch, game launch batch,
dosbox.conf, exception batch (optional)
* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* Install.bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

The Language Pack Concept

2021-11-08T11:14:36Z

Timber:

<div style="float:right;">__TOC__</div>

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized install batch, game launch batch,
dosbox.conf, exception batch (optional)
* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* Install.bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

The Language Pack Concept

2021-11-08T11:11:07Z

Timber: /* Adding a game to the language pack */

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized install batch, game launch batch,
dosbox.conf, exception batch (optional)
* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* Install.bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

==== add ====

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== keep ====

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

==== mlingame ====

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

==== mlstartup ====

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

The Language Pack Concept

2021-11-08T11:10:16Z

Timber:

== Technical Specs ==

=== Core concepts overview ===

Language Packs are “add-ons”. They need eXoDOS full installed.
Yet they are designed to be as separate as possible to avoid conflicts, overwrites and complicated merges that require parsing and validating existing data, at the cost of some potential data duplication.

* Each language is a separate pack. Users can install several as they do not overlap
* Each language pack has its own release schedule, asynchronous from eXoDOS or other language packs
* Each language pack includes its own XML that its installer will merge in eXoDOS’ “MS-DOS.xml” leveraging the existing “merge.bat” util
* Each language pack includes its own Playlist (xml) with all games included in the language pack and all games, which are already included in eXoDOS and contain beside English among other also this language
* eXoDOS start scripts (batch files) always check if there are different language versions available and let the user select their prefered language
* For games that do not exist in base-eXoDOS, a new game entry is appended to MS-DOS.xml
* Multilanguage games (that may or may not exist in eXoDOS already) where language is set during installation or setup or through a change of files get their own standalone preconfigured entry, which implies duplication of sources
* Multilanguage games (that exist in eXoDOS already) where language is set during startup or ingame are linked to the base-eXoDOS entry in the language playlist

=== Structure ===
As separate add-ins, language pack files are stored in their own folder structure that plugs to
eXoDOS (examples are for the French language pack)

==== xml\french ====
* Contains the LB platform XML files (“french.xml” and “frenchfamily.xml”) that will be
merged into MS-DOS.xml in the same folder by the language pack setup.

==== eXo\eXoDOS\!french ====
* Contains all localized game zips and is the destination for installed games. Functional equivalent of “ \eXo\eXoDOS” for regular eXoDOS

==== eXo\eXoDOS\!dos\!french ====
* Contains individual game folders that include localized install batch, game launch batch,
dosbox.conf, exception batch (optional)
* Each game folders contain an “Extras” subfolder for localized manual and other documents
as well as a localized Alternate Launcher.bat
* Functional equivalent of “X:\eXoDOS\eXo\eXoDOS\!dos” for regular eXoDOS

==== Images\MS-DOS\<image type>\France ====
* Localized game images should be stored in a regional subfolder for easier packing.
LaunchBox already has pre-configured folders such as France and Germany. A new folder
should be created if necessary.

After discussion with eXo, this requires a little more work as it is probable LB just loads images based on its “region” settings. Open question is: are multiple regions supported for a single game, and if yes, will it fetch images in all region folders? This is a problem for existing games mainly, as new games (=not existing in eXoDOS) will be added with the proper region.
I tested the whole image thing in LB. The regions currently set in Launchbox are „North America“ and „United States“ in this order. The Language pack setup has to add the language pack region and set the order to „<language pack language>“, „United States“, „North America“. LB loads the Images in this order then from the folders

==== eXo\dosbox ====
* Contains a localized config.bat file (renamed to config_FR.bat for French), for global DOSBox
settings management

Is this really needed? It would be called in the eXo/util/!german/Launch.bat

==== eXo\util\!french ====
* Contains all localized util files:
** dosbox.txt (with the matching table for the games<->dosbox version
** multiplayer.txt (with the matching table "game has multiplayer options")
** openFolder.bat (the batch file to open the extras folder for the language pack (see "Launchbox integration")
** Launch.bat (the batch that launches the games)

==== eXo\LanguagePacks\french (YET TO BE DEFINED – Placeholder) ====
* Contains setup batch + other necessary files for language packs setup and management.

My suggestion would be to include localized setup batches in every language pack in their
own folder, then instruct users to extract the language pack over their existing eXoDOS
installation, then browse to “LanguagePacks\French” and run setup_FR.bat there, for
example. This way in the case of several language packs installed, the setup files do not
overwrite each other in a different language, and we do not have to worry about asking the
user what languages he wants the setup in. The language of the setup is always in the
language of the pack it belongs to. Yet if it finds several language XML’s, it installs all of them

=== Setup and update ===
The full setup mechanism is still to be precisely defined at this stage.

==== Existing base concepts: ====
* Extraction of the xml files to the xml folder
* Extraction of all localized game zips to the localized game folder
* Extraction of all game files and extras to the localized “!dos” folder
* Extraction of all pictures to the region-specific images folders
* Extraction of the localized config batch file
* Extraction of the localized util-folder files

==== XML Merging: ====
* Merge.bat parses all xml files in the xml folder and identifies installed language pack(s)
* Asks the user if he wants adult games or not to select the proper source XML from the
language pack(s) and the proper destination XML from the base eXoDOS install
* Merges the appropriate language pack(s) xml files into the chosen base xml.
** Adult games included: merges french.xml (+other installed language packs) into base
MS-DOS.xml, copy to Data\Platforms
** Adult games excluded: merges frenchfamily.xml (+other installed language packs)
into dosfamily.xml and copy to Data\Platforms as MS-DOS.xml

This implies every time a language pack is installed (be it for the first time or for an update),
it creates a new clean MS-DOS.xml, overwriting potential manual changes.
that’s the same with base-eXoDOS, it would overwrite the xml – I think manual changes shouldn‘t be considered

=== Bat files localization ===

Game install and launch bat files need to have their “echo” instructions localized for a better user experience. A template of files is created for each language.
The download on demand mechanism is stripped out, as language packs will only be released as full packages (no “lite” releases).
To support foreign languages accents and special characters, the codepage of batch files needs to be changed to Unicode (UTF-8). This is done by adding these lines to the beginning of batch files to call a codepage change to 65001 (ref: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers)

I think we should stick with ae/oe/ue and no special characters …
We need to use special editor-config to edit the batch files. A „normal“ edit with notepad would „destroy“ the file – I think that’s a high risk for failures? - needs to be discussed but maybe every language pack admin can decide himself?

: @echo off
: REM call Codepage 65001 for UTF-8 accents support
: @chcp 65001
: cls

The files that need translation are:
* Install.bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* Gamename (year).bat (in every “!dos\!french\”-game folder - the file is always the same and can just be copied to every folder)
* exception.bat (optional in the game folder ("eXo\eXoDOS\!dos\!french\..."), mostly for scummvm games
* Alternate Launcher.bat (in every game folder “Extras” subfolder)
* Config.bat (only once in “eXo\Dosbox”, renamed to config_fr.bat)
* Launch.bat (only once in "eXo\util", moved to "eXo\util\!french")

=== Games packaging and localized names ===
Games are packaged in the same format as other eXoDOS games: GameName (year).zip
When an official localized name exists for a game, this should be used instead of the English
name.

currently this works because the eXoDOS batch "searches" for the game folder, so this has to be named the same as in eXoDOS
But: the current way the games that only have extras but no language specific game in the language pack won't work. Because they also have the game folder (where the extras are in), the eXoDOS batch will find it and let the user choose the language, then tries to start the game name (year).bat, which isn't there...
So I think it needs to be the same file name as in eXoDOS (as long as the game is already in eXoDOS) and the eXoDOS batch has to be changed to look for the game name (year).bat instead of only the game name folder

=== LaunchBox integration ===
Three additional applications need to be merged into existing games, with the language as prefix
to sort them out properly:

* Standard game
* Alternate Launcher (pixel perfect & shader options)
* Open Extras folder (for localized manuals and docs)

Example for Space Quest IV French:

“Open Folder.bat” is a simple batch: “explorer.exe .” that opens explorer from the folder the
batches is run from.
These new entries should also be localized themselves for consistency.
How it looks in the contextual menu:

What about new games that do not exist yet in eXoDOS? We just merge a full game entry in the
french.xml instead of an additional application? Unlikely scenario – what happens if two language
packs both insert the same game that doesn’t exist in eXoDOS (ie, a game that would only exist in
French and German but not English). Borderline, I know...
It’s part of the „Add a game to the language pack“ section

=== Language Playlists ===
Every language pack comes with it’s own language games playlist. For example: French_Playlis.xml
It contains all the games of the language pack, whether they were added by the language pack or they were already in base-eXoDOS
On how the playlist is created look at the „lists and automatism“ section

== Lists and automatism ==

We created scripts to export from our spreadsheet lists to XML files for Launchbox (and to be merged with the eXoDOS base pack XMLs)

=== Google spreadsheet ===

The google spreadsheet (https://docs.google.com/spreadsheets/d/1x19Yw1ZnRYF1vwTXd9PTGxqZBQkkEtPmjiqlUUdq1oY/edit?usp=sharing) contains a sheet for every language. The eXoID column is filled automatically by script from the master sheet.

Every language pack has it's own spreadsheet. Here's the one for the German language pack (GLP): https://docs.google.com/spreadsheets/d/1C1nRFVZkBHWodF7tOHm5hWA0YV45svLEQCUMCUl70dA
It needs a sheet called "*LP" (* for the language-letter, example: "GLP" for the German pack, "FLP" for the French pack, "PLP" for the polish pack ...), a sheet called "extras" and, if magazines shall be included, a sheet called "magazines"
All other sheets are optional.

==== xLP sheet ====

This sheet contains the games list. From this list the final XML file to be merged with eXoDOS' "MS-DOS.XML" is automatically created.
Therefor it needs the following columns:

* A ("eXoID") = cross matching to the eXoDOS master table (if the game is already in eXoDOS)
* D ("Game") = it’s the title of the game in eXoDOS
* E ("LP Name") = it’s the title of the game in the language pack (= will be set as an alternate title in LaunchBox)
* G ("batchname") = it's the name of the game batch (game name (year)), important for the creation of the /eXo/util/!<language>/dosbox.txt
* H ("Folder") = it’s the folder of the game in eXoDOS. It must be the same in the language pack for the batch files to work correct. eXo has build a language switch that checks the language-folder (eXo/eXoDOS/!dos/!german) for a game folder and lets the user select the language version to start the game with checkup should be changed to the game name (year) batch file ... see "Games packaging and localized names"
* T ("variant") = that column decides, which variant is used for the game (see chapter 4)
* W ("dosbox") = contains the call for the dosbox-version - the eXo/util/!german/dosbox.txt is filled from that column (and the batchname column)
* AC ("LB-ID") = it’s the ID LaunchBox uses for connecting the game with it’s additional applications, alternate names and playlists in the xml files. The automation-script needs it to create the xml files for the language pack - for games that are already in eXoDOS it has to be the same as in eXoDOS base package (to link the language pack's additionalApplication to the original entry). For language pack exclusive games that aren't in eXoDOS base package, the LB-ID can be created with every UUID v4 generator (like https://www.uuidgenerator.net/version4)

==== extras sheet ====

This sheet contains the list of extras for a game.
The extra files themselves are placed in the folder: /eXo/eXoDOS/!dos/!<language>/<game folder>/Extras
The rows in this sheet are needed for the automation to create the "Additional Application" entries in the XML files

* A-C (eXoID, LB-ID, game name) = these columns are filled automatically by writing a foldername in column D
* D (folder) = here the game folder name has to be used. from this the macros will fill columns A to C automatically. It's needed to cross match the entries with the game entries for creating the XML files afterwards
* E (filename) = the name + extension of the extras file (no folders needed)
* F (title) = the title or name of the File - it will be used for the Extras entry in the right-click menu of Launchbox
* G (english) = the title or name in english (not used yet, but maybe we decide to switch the name in Launchbox to this, starting with "(<LANGUAGE>) "?)


not needed atm because we only add an "Additional Application" to open the Extras folder of the game. but should be filled out anyway because maybe this changes someday because of possibility of creating cascading menus in LB for example

==== magazines sheet ====

Here all game reviews, previews, hints ... that were found in magazines can be placed to enable direct linking of them to a game in the language pack.
The automation script will create an AdditionalApplication entry using sumatra pdf to open the magazin on the correct page for the game review (or preview or hints or whatever)

the Magazines are placed in the folder /eXo/Magazines/!german/<Magazine-name>

==== guides sheet ====

same as magazines sheet but for game guides

the guides are placed in the folder /eXo/Guides/!german/

=== Language pack xml creation ===
The automation script creates the language pack xmls (french.xml and frenchfamily.xml). They contain all the entries that will be added to the MS-DOS.xml when the language pack is installed
It’s based on the google spreadsheet (see "Google spreadsheet")

insert script listings here

== Adding a game to the language pack ==

=== Procedure ===

image missing

=== Variants ===

The variants are set in the google spreadsheet (see "Google spreadsheet") on sheet "xLP" in column "T (variant)"

==== new ====

the game is not in eXoDOS, only in the language pack

* <gamefolder> has to be named (unique)
* Game Name (XXXX) has to be set (in most cases mobygames can be uses as source)
* Manual is placed in /Manuals/MS-DOS/<Launchbox-gamename>.pdf
* Music file is placed in /Music/MS-DOS/<Launchbox-gamename>.mp3
* Video is placed in /Videos/MS-DOS/<Launchbox-gamename>.mp4
* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras have to be placed in /eXo/eXoDOS/!dos/!german/<game folder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „new“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* game gets its own new entry in Launchbox (LBID will be set during XML creation)
* game is added to the German playlist
* extras will be linked as additional applications to that LB entry like in eXoDOS
* Manual is automatically set by LB
* Music is automatically set by LB
* Video is automatically set by LB
* Images are automatically set by LB

==== extras ====

the game is already in eXoDOS and only extras (manuals, documents …) will be added by the language pack

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „extras“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* for German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* German images are automatically set by LB

=== add ===

the game is already in eXoDOS but it’s not in German - so German game version will be added by the language pack

* Game files have to be placed in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Install.bat, Game Name (XXXX).bat and dosbox.conf have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* exception.bat (if needed) has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists)
* Extras and Manual have to be placed in eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „varaiant“ column to „add“
** add extras rows in the extras sheet (they will be automatically added to the XML for the merge

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

=== keep ===

the game is already in eXoDOS and it is German language only - so language pack only needs to add the playlist entry

* Extras, Images, Manuals can all be added to the eXoDOS base package
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „keep“
** IMPORTANT: Set column R = eXoDOS to „Y“ (= the game is only added to the playlist.xml for the language pack)

overview:
* Game will only be added to the German playlist

=== mlingame ===

the game is already in eXoDOS and it's a multilanguage version with language choice ingame (menu or key combination)

* create Game Name (XXXX).ba1 in /eXo/eXoDOS/!german/<gamefolder> (create folder if not exists)
* zip the /eXo/eXoDOS/!german/<gamefolder> and rename the zip to Game Name (XXXX).zip
* Game Name (XXXX).bat has to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder> (create folder if not exists) with German info and steps on how to change the language ingame and loop back to the eXoDOS start batch
* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set "variant" column to „mlingame“
** add extras rows in the extras sheet (they will be automatically added to the XML)

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

=== mlstartup ===

the game is already in eXoDOS and it's a multilanguage version with language choice at startup (either in the eXoDOS batch files or at game startup)

* Extras and Manual have to be placed in /eXo/eXoDOS/!dos/!german/<gamefolder>/Extras (create folder if not exists)
* Images (at least the types "box – front", "box – back", "disc", "screenshot gametitle" and "screenshot gameplay") have to be placed in /Images/MS-DOS/<type>/German/<Launchbox-gamename>-xx.<ext> (xx = counter starting with 01, <ext> = file extension of the image file)
* In German language pack spreadsheet:
** fill out the columns for the game (or add new row if game is not in yet) -> important: set „variant“ column to „mlstartup“
** add extras rows in the extras sheet (they will be automatically added to the XML )

overview:
* Game is added to the German playlist
* For German extras and manual there will be an additional application to the eXoDOS entry „Deutsche Extras und Dokumente“ opening the German extras folder
* Images are automatically set by LB

The Language Pack Concept

2021-11-08T10:50:39Z

Timber: /* = xLP sheet */

The Language Pack Concept

2021-11-08T10:50:27Z

Timber: /* = *LP sheet */

The Language Pack Concept

2021-11-08T10:50:04Z

Timber:

The Language Pack Concept

2021-11-08T10:21:17Z

Timber: /* Language Playlists */

The Language Pack Concept

2021-11-08T10:20:57Z

Timber: /* LaunchBox integration */

The Language Pack Concept

2021-11-08T10:19:40Z

Timber: /* Games packaging and localized names */

The Language Pack Concept

2021-11-08T10:15:32Z