eXo Wiki - User contributions [en]

https://wiki.retro-exo.com/api.php?action=feedcontributions&feedformat=atom&user=Parricc eXo Wiki - User contributions [en] 2026-05-13T12:55:54Z User contributions MediaWiki 1.37.2 https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1073 Batch Conversion Limitations 2026-04-25T17:06:58Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting multi-line nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert. <u>Each indentation should be specifically 2 or 3 spaces.</u> Avoid tabs.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. Correct indentation on closing parentheses is especially important as that is how the converter determines the boundary.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Something like this is also okay:<br /> <pre style="color: blue;"><br /> if %nsl%==On (<br /> if %PPmode%==Off (<br /> if %filter%==On (<br /> set conf=".\emulators\dosbox\Staging_noline_sl.conf"<br /> goto preinstall)))<br /> </pre>When all of the closing parenthesis are together, the converter splits them apart and converts each one as appropriate.<br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1072 Batch Conversion Limitations 2026-04-25T17:06:22Z

<p>Parricc: Noted that each indentation should be either 2 or 3 spaces.</p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting multi-line nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert. <u>Each indentation should be specifically 2 or 3 spaces.</u><br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. Correct indentation on closing parentheses is especially important as that is how the converter determines the boundary.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Something like this is also okay:<br /> <pre style="color: blue;"><br /> if %nsl%==On (<br /> if %PPmode%==Off (<br /> if %filter%==On (<br /> set conf=".\emulators\dosbox\Staging_noline_sl.conf"<br /> goto preinstall)))<br /> </pre>When all of the closing parenthesis are together, the converter splits them apart and converts each one as appropriate.<br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1071 Batch Conversion Limitations 2026-04-21T19:51:34Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting multi-line nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. Correct indentation on closing parentheses is especially important as that is how the converter determines the boundary.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Something like this is also okay:<br /> <pre style="color: blue;"><br /> if %nsl%==On (<br /> if %PPmode%==Off (<br /> if %filter%==On (<br /> set conf=".\emulators\dosbox\Staging_noline_sl.conf"<br /> goto preinstall)))<br /> </pre>When all of the closing parenthesis are together, the converter splits them apart and converts each one as appropriate.<br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1070 Batch Conversion Limitations 2026-04-21T19:48:50Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting multi-line nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. Indentation on closing parentheses is especially important as that is how the converter determines the boundary.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Something like this is also okay:<br /> <pre style="color: blue;"><br /> if %nsl%==On (<br /> if %PPmode%==Off (<br /> if %filter%==On (<br /> set conf=".\emulators\dosbox\Staging_noline_sl.conf"<br /> goto preinstall)))<br /> </pre><br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1069 Batch Conversion Limitations 2026-04-21T19:44:45Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting multi-line nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. The closing parentheses are especially important.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Something like this is also okay:<br /> <pre style="color: blue;"><br /> if %nsl%==On (<br /> if %PPmode%==Off (<br /> if %filter%==On (<br /> set conf=".\emulators\dosbox\Staging_noline_sl.conf"<br /> goto preinstall)))<br /> </pre><br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Main_Page&diff=1068 Main Page 2026-04-21T18:57:08Z

<p>Parricc: /* Linux Patch */</p> <hr /> <div>= <div style="text-align:center;">[[File:RetroeXo Logo.png]]<br>'''Retro eXo'''</div> =<br /> <strong>Project Goal</strong><br><br /> The eXo projects' goal is preservation through playability.<br><br /> <br /> <strong>Project Resources</strong><br><br /> '''[http://www.retro-exo.com www.retro-exo.com]''': Project Homepage.<br><br /> '''[https://www.youtube.com/c/eXoRetro YouTube Channel]''': Various videos about the project and how to use it.<br><br /> '''[https://discord.gg/37FYaUZ Discord]''': Project discussion, chat, & community.<br><br /> '''[https://github.com/exoscoriae/ Github]''': Bugs, submissions, and enhancements are tracked here.<br><br /> <br /> == Projects ==<br /> === Current ===<br /> ==== [[EXODOS|eXoDOS]] ====<br /> <small>Current Version: eXoDOS v6.04<br><br /> Release Date: November 28th, 2024<br><br /> Number of Games: 7,666<br><br /> Upcoming Version: TBD<br><br /> </small><br><br /> ==== [[EXOWin3x|eXoWin3x]] ====<br /> <small>Current Version: eXoWin3x v2<br><br /> Release Date: February 14th, 2021<br><br /> Number of Games: 1,138<br><br /> Upcoming Version: eXoWin3x v3<br><br /> </small><br><br /> <br /> ==== [[EXOScummVM|eXoScummVM]] ====<br /> <small>Current Version: eXoScummVM v2026.1.0<br><br /> Release Date: February 14th, 2026<br><br /> Number of Games: 832 unique titles, multiple variations of each<br><br /> Upcoming Version: TBD<br><br /> </small><br><br /> <br /> ==== [[EXODREAMM|eXoDREAMM]] ====<br /> <small>Current Version: eXoDREAMM v4.0<br><br /> Release Date: March 2nd, 2026<br><br /> Number of Games: 62<br><br /> Upcoming Version: Unknown<br><br /> </small><br><br /> <br /> ==== [[EXORLP|eXoRLP]] ====<br /> <small>Current Version: eXo's Retro Learning Pack<br><br /> Release Date: April 1st, 2020<br><br /> Number of Games: 667 titles, compiled from eXoDOS and eXoWin3x<br><br /> 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.<br></small><br /> <br /> <br><br /> <br /> ==== [[EXOAppleIIGS|eXoAppleIIGS]] ====<br /> <br /> <small>Current Version: eXoAppleIIGS v1<br><br /> Release Date: October 31st, 2022<br><br /> Number of Games: 460<br><br /> Upcoming Version: eXoAppleIIGS v2<br><br /> <br></small><br /> <br /> ==== [[EXODemoScene|eXoDemoScene]] ====<br /> <br /> <small>Current Version: eXoDemoScene v2.1<br><br /> Release Date: February 21st, 2026<br><br /> Number of Demos: 2,424<br><br /> Upcoming Version: TBD<br><br /> <br></small><br /> <br /> ==== [[EXOIF|eXoIF]] ====<br /> <br /> <small>Current Version: eXoIF v2.00<br><br /> Release Date: April 9th, 2026<br><br /> Number of Games: 2332<br><br /> Upcoming Version: TBD<br><br /> <br></small><br /> <br /> ==== [[EXOWin9x|eXoWin9x]] ====<br /> <small>Current Version: Vol. 1<br><br /> Release Date: November 22, 2025<br><br /> Number of Games: 664<br><br /> Upcoming Version: Vol. 2<br><br /> </small><br><br /> <br /> == History ==<br /> 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.<br><br><br /> 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 MEAGRE front end, which was also originally posted as a member project on the UG forums.<br><br><br /> 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.<br><br><br /> 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 multiple volunteers stepping forward to improve key aspects of the projects. This resulted in 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.<br><br><br /> 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].<br /> <br /> == Media ==<br /> The project and/or creator have been featured in the following articles:<br /> <br /> [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]<br><br /> [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.]<br><br /> [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]<br><br /> [https://www.retrorgb.com/interview-with-exo-pc-ms-dos-and-windows-game-preservationist.html '''''Interview with eXo: PC, MS-DOS and Windows game preservationist''''' - Mons, D. (2022, Apr. 7). RetroRGB]<br><br /> [https://www.emunewz.net/forum/showthread.php?tid=249003 '''''eXo, the author of eXoDOS''''' - nickblame (2023, Dec. 27). EmuNewz]<br /> <br /> == Contributors ==<br /> [[Project Contributors]]<br /> <br /> == Known Issues ==<br /> [[EXODOS Known Issues|eXoDOS Known Issues]]<br><br /> [[EXOScummVM#Known Issues|eXoScummVM Known Issues]]<br><br /> <br /> == Technical Information ==<br /> === Emulated Hardware ===<br /> [[3Dfx]]<br><br /> [[Sound Cards]]<br><br /> [[Video Modes]]<br><br /> [[Remote Multiplayer]]<br><br /> [[ReelMagic]]<br><br /> <br /> === Common Core Systems ===<br /> [[Project Setup]]<br><br /> [[Installer]]<br><br /> [[Launcher]]<br><br /> [[DOSBox Configuration File]]<br><br /> [[Downloader]]<br><br /> [[EXO Plugin|eXo Plugin]]<br><br /> <br /> === Emulators ===<br /> [[DOSBox]]<br><br /> [https://wiki.scummvm.org/index.php?title=Main_Page ScummVM]<br><br /> [https://aarongiles.com/dreamm/ DREAMM]<br><br /> <br /> === Unique Modules ===<br /> [[Save Game Transfer]]<br><br /> [[Gold Box Companion]]<br><br /> [[All-Seeing Eye]]<br><br /> [[Ultimapper 5]]<br><br /> <br /> === Metadata ===<br /> [[Images]]<br><br /> [[LaunchBox Platform XML]]<br><br /> [[Interactive Code Wheels]]<br><br /> [[Manuals]]<br><br /> [[Music]]<br><br /> [[Playlists]]<br><br /> [[Video Snaps]]<br><br /> <br /> === Media Add-On Pack ===<br /> [[Books]]<br><br /> [[Catalogs]]<br><br /> [[Magazines]]<br><br /> [[Soundtracks]]<br><br /> [[Videos]]<br><br /> <br /> === Database ===<br /> [[Master Database]]<br><br /> <br /> == Game Specific Projects ==<br /> DOOM - [[EXOWAD|eXoWAD]]<br><br /> ZZT - [[EXOZZT|eXoZZT]]<br><br /> [[Unlimited Adventures]]<br /> <br /> == Language Packs ==<br /> <br /> [[The Language Pack Concept]]<br /> <br /> === Completed ===<br /> [[German Language Pack]]<br><br /> [[Polish Language Pack]]<br><br /> [[Spanish Language Pack]]<br><br /> <br /> === In Progress ===<br /> Chinese Language Pack<br><br /> French Language Pack<br><br /> Portuguese Language Pack<br><br /> <br /> === In need of a curator ===<br /> Hebrew Language Pack<br><br /> Italian Language Pack<br><br /> Japanese Language Pack<br><br /> Korean Language Pack<br><br /> Russian Language Pack<br><br /> <br /> <small>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.</small><br /> <br /> == Linux Patch ==<br /> [[Linux Patch|Linux Patches]]<br /> <br /> [[Batch Conversion Limitations]]<br /> <br /> == FAQ ==<br /> For a list of frequently asked questions, please visit the [[FAQ]] page.<br /> <br /> == Contact ==<br /> <br /> If you would like to contribute, please contact [[User:EXO|eXo]] for registration.<br /> <br /> <br /> <br /> <br /> <br /> </div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1067 Batch Conversion Limitations 2026-04-21T18:54:21Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. The closing parentheses are especially important.<br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre style="color: red;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre style="color: blue;"><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1066 Batch Conversion Limitations 2026-04-21T18:51:57Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. The closing parentheses are especially important.<br /> <br /> Example that successfully converts:<br /> <pre><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> <br /> Example that fails to convert:<br /> <pre><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1065 Batch Conversion Limitations 2026-04-21T18:47:40Z

<p>Parricc: /* Indenting nested if statements and for loops is necessary. */</p> <hr /> <div>For batch files to successfully convert into bash files for Linux and MacOS, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting nested if statements and for loops is necessary. ===<br /> With the limitations of tooling, nested statements that written without indentation, such as the below example, will fail to convert:<br /> <pre><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> Instead, anything that is nested should have spacing to indicate the level of nesting. The closing parentheses are especially important.<br /> <br /> Example that correctly converts:<br /> <pre><br /> if [...] (<br /> some command<br /> if [...] (<br /> some command<br /> )<br /> )<br /> </pre><br /> <br /> === Labels must never be placed inside of loops or conditions. ===<br /> The converted goto function has been designed to work through stack frames for Linux and MacOS. For this reason, a label must never be placed inside of a loop or condition. Such code will fail to convert.<br /> Example:<br /> <pre><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> :mylabel<br /> echo This does not convert<br /> )<br /> </pre><br /> <br /> Example that successfully converts:<br /> <pre><br /> if exist file2.txt goto mylabel<br /> if exist .\mydir\file1.txt (<br /> echo file1 exists<br /> goto mylabel<br /> )<br /> goto skip<br /> :mylabel<br /> echo This does not converts<br /> :skip<br /> </pre></div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1064 Batch Conversion Limitations 2026-04-21T18:15:55Z

<p>Parricc: </p> <hr /> <div>For batch files to successfully convert into bash files for Linux, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> === Indenting nested if statements and for loops is necessary. ===<br /> <br /> === Labels must never be placed inside of loops. ===</div>

Parricc https://wiki.retro-exo.com/index.php?title=Batch_Conversion_Limitations&diff=1063 Batch Conversion Limitations 2026-04-21T18:13:55Z

<p>Parricc: describes conversion limitations that must be considered when editing batch files</p> <hr /> <div>For batch files to successfully convert into bash files for Linux, there are some limitations for how they can be written. This page is to ensure that team members writing batch files are aware of some of those limitations.<br /> <br /> Indentation of nested if statements and loops is necessary.<br /> <br /> <br /> Labels must never be placed inside of loops.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Main_Page&diff=1062 Main Page 2026-04-21T17:53:23Z

<p>Parricc: Renamed Linux Patches Link</p> <hr /> <div>= <div style="text-align:center;">[[File:RetroeXo Logo.png]]<br>'''Retro eXo'''</div> =<br /> <strong>Project Goal</strong><br><br /> The eXo projects' goal is preservation through playability.<br><br /> <br /> <strong>Project Resources</strong><br><br /> '''[http://www.retro-exo.com www.retro-exo.com]''': Project Homepage.<br><br /> '''[https://www.youtube.com/c/eXoRetro YouTube Channel]''': Various videos about the project and how to use it.<br><br /> '''[https://discord.gg/37FYaUZ Discord]''': Project discussion, chat, & community.<br><br /> '''[https://github.com/exoscoriae/ Github]''': Bugs, submissions, and enhancements are tracked here.<br><br /> <br /> == Projects ==<br /> === Current ===<br /> ==== [[EXODOS|eXoDOS]] ====<br /> <small>Current Version: eXoDOS v6.04<br><br /> Release Date: November 28th, 2024<br><br /> Number of Games: 7,666<br><br /> Upcoming Version: TBD<br><br /> </small><br><br /> ==== [[EXOWin3x|eXoWin3x]] ====<br /> <small>Current Version: eXoWin3x v2<br><br /> Release Date: February 14th, 2021<br><br /> Number of Games: 1,138<br><br /> Upcoming Version: eXoWin3x v3<br><br /> </small><br><br /> <br /> ==== [[EXOScummVM|eXoScummVM]] ====<br /> <small>Current Version: eXoScummVM v2026.1.0<br><br /> Release Date: February 14th, 2026<br><br /> Number of Games: 832 unique titles, multiple variations of each<br><br /> Upcoming Version: TBD<br><br /> </small><br><br /> <br /> ==== [[EXODREAMM|eXoDREAMM]] ====<br /> <small>Current Version: eXoDREAMM v4.0<br><br /> Release Date: March 2nd, 2026<br><br /> Number of Games: 62<br><br /> Upcoming Version: Unknown<br><br /> </small><br><br /> <br /> ==== [[EXORLP|eXoRLP]] ====<br /> <small>Current Version: eXo's Retro Learning Pack<br><br /> Release Date: April 1st, 2020<br><br /> Number of Games: 667 titles, compiled from eXoDOS and eXoWin3x<br><br /> 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.<br></small><br /> <br /> <br><br /> <br /> ==== [[EXOAppleIIGS|eXoAppleIIGS]] ====<br /> <br /> <small>Current Version: eXoAppleIIGS v1<br><br /> Release Date: October 31st, 2022<br><br /> Number of Games: 460<br><br /> Upcoming Version: eXoAppleIIGS v2<br><br /> <br></small><br /> <br /> ==== [[EXODemoScene|eXoDemoScene]] ====<br /> <br /> <small>Current Version: eXoDemoScene v2.1<br><br /> Release Date: February 21st, 2026<br><br /> Number of Demos: 2,424<br><br /> Upcoming Version: TBD<br><br /> <br></small><br /> <br /> ==== [[EXOIF|eXoIF]] ====<br /> <br /> <small>Current Version: eXoIF v2.00<br><br /> Release Date: April 9th, 2026<br><br /> Number of Games: 2332<br><br /> Upcoming Version: TBD<br><br /> <br></small><br /> <br /> ==== [[EXOWin9x|eXoWin9x]] ====<br /> <small>Current Version: Vol. 1<br><br /> Release Date: November 22, 2025<br><br /> Number of Games: 664<br><br /> Upcoming Version: Vol. 2<br><br /> </small><br><br /> <br /> == History ==<br /> 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.<br><br><br /> 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 MEAGRE front end, which was also originally posted as a member project on the UG forums.<br><br><br /> 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.<br><br><br /> 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 multiple volunteers stepping forward to improve key aspects of the projects. This resulted in 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.<br><br><br /> 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].<br /> <br /> == Media ==<br /> The project and/or creator have been featured in the following articles:<br /> <br /> [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]<br><br /> [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.]<br><br /> [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]<br><br /> [https://www.retrorgb.com/interview-with-exo-pc-ms-dos-and-windows-game-preservationist.html '''''Interview with eXo: PC, MS-DOS and Windows game preservationist''''' - Mons, D. (2022, Apr. 7). RetroRGB]<br><br /> [https://www.emunewz.net/forum/showthread.php?tid=249003 '''''eXo, the author of eXoDOS''''' - nickblame (2023, Dec. 27). EmuNewz]<br /> <br /> == Contributors ==<br /> [[Project Contributors]]<br /> <br /> == Known Issues ==<br /> [[EXODOS Known Issues|eXoDOS Known Issues]]<br><br /> [[EXOScummVM#Known Issues|eXoScummVM Known Issues]]<br><br /> <br /> == Technical Information ==<br /> === Emulated Hardware ===<br /> [[3Dfx]]<br><br /> [[Sound Cards]]<br><br /> [[Video Modes]]<br><br /> [[Remote Multiplayer]]<br><br /> [[ReelMagic]]<br><br /> <br /> === Common Core Systems ===<br /> [[Project Setup]]<br><br /> [[Installer]]<br><br /> [[Launcher]]<br><br /> [[DOSBox Configuration File]]<br><br /> [[Downloader]]<br><br /> [[EXO Plugin|eXo Plugin]]<br><br /> <br /> === Emulators ===<br /> [[DOSBox]]<br><br /> [https://wiki.scummvm.org/index.php?title=Main_Page ScummVM]<br><br /> [https://aarongiles.com/dreamm/ DREAMM]<br><br /> <br /> === Unique Modules ===<br /> [[Save Game Transfer]]<br><br /> [[Gold Box Companion]]<br><br /> [[All-Seeing Eye]]<br><br /> [[Ultimapper 5]]<br><br /> <br /> === Metadata ===<br /> [[Images]]<br><br /> [[LaunchBox Platform XML]]<br><br /> [[Interactive Code Wheels]]<br><br /> [[Manuals]]<br><br /> [[Music]]<br><br /> [[Playlists]]<br><br /> [[Video Snaps]]<br><br /> <br /> === Media Add-On Pack ===<br /> [[Books]]<br><br /> [[Catalogs]]<br><br /> [[Magazines]]<br><br /> [[Soundtracks]]<br><br /> [[Videos]]<br><br /> <br /> === Database ===<br /> [[Master Database]]<br><br /> <br /> == Game Specific Projects ==<br /> DOOM - [[EXOWAD|eXoWAD]]<br><br /> ZZT - [[EXOZZT|eXoZZT]]<br><br /> [[Unlimited Adventures]]<br /> <br /> == Language Packs ==<br /> <br /> [[The Language Pack Concept]]<br /> <br /> === Completed ===<br /> [[German Language Pack]]<br><br /> [[Polish Language Pack]]<br><br /> [[Spanish Language Pack]]<br><br /> <br /> === In Progress ===<br /> Chinese Language Pack<br><br /> French Language Pack<br><br /> Portuguese Language Pack<br><br /> <br /> === In need of a curator ===<br /> Hebrew Language Pack<br><br /> Italian Language Pack<br><br /> Japanese Language Pack<br><br /> Korean Language Pack<br><br /> Russian Language Pack<br><br /> <br /> <small>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.</small><br /> <br /> == Linux Patch ==<br /> [[Linux Patch|Linux Patches]]<br /> <br /> == FAQ ==<br /> For a list of frequently asked questions, please visit the [[FAQ]] page.<br /> <br /> == Contact ==<br /> <br /> If you would like to contribute, please contact [[User:EXO|eXo]] for registration.<br /> <br /> <br /> <br /> <br /> <br /> </div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=656 Linux Patch 2024-09-13T04:03:03Z

<p>Parricc: /* Linux Flatpaks */ completed flatpak runtime list</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows, including both the lite and full versions. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> An add-on zip is also available as a separate download to add Linux support to the Media Pack.<br /> <br /> <nowiki>*</nowiki>Note: The German Language Pack has not yet been converted*<br /> <br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''!languagepacks/launch.bsh''' - language pack support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''!languagepacks/launch.msh''' - language pack support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''AltLauncher.bsh''' - support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''AltLauncher.msh''' - support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''EXTDOS_linux.zip''' - contains Linux flatpaks, update files, AppImages, and emulator support files (bak, bsh, command, conf, txt) <br /> :*'''alt_dosbox_linux.txt''' - defines the command to launch DOSBox for the alternate launcher (<span style="color: red">must be DOSBox Staging to not break conf files)<br /> :*'''alt_launch_linux.txt''' - defines the directory containing the DOSBox Staging resource folder used by eXoDOS for the alternate launcher<br /> :*'''converter.bash''' - support file for regenerate.bash that converts bat files to bash files using a long series of substitution commands<br /> :*'''dosbox_linux.txt''' - defines what version of DOSBox is used by each game in Linux<br /> :*'''eXoLBpm_linux.py''' - The LaunchBox Parents.xml merging tool for Linux<br /> :*'''eXoLPLBXMLedit_linux.py''' - The eXoDOS Language Pack LaunchBox XML edit tool for Linux<br /> :*'''eXoLPPPM_linux.py''' - The eXoDOS Language Pack Playlist Parents Merger tool for Linux<br /> :* '''exodos.png''' - png file that can be used as a custom icon in Steam<br /> :*'''exodosvi_cover.jpg''' - Box art image that can be used as a custom background in Steam<br /> :*'''install.bsh''' - support file for Linux game install scripts (gets called by the install.bsh script in the game directory)<br /> :*'''install.msh''' - support file for macOS game install scripts (gets called by the install.msh script in the game directory)<br /> :*'''ip.bsh''' - support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''ip.msh''' - support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''launch.bsh''' - support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''launch.msh''' - support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''regenerate.bash''' - location sensitive development script used to convert unzipped files from eXo collections to Linux and macOS<br /> :*'''version.bsh''' - Linux support file for version.command<br /> :*'''version.command''' - This tells the currently installed version of eXoDOS<br /> :*'''version.msh''' - macOS support file for version.command<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Development Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> ====eXo/util/converter.bash====<br /> : The '''converter.bash''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.bash''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.bash''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.bash''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.bash''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.bash<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.bsh"<br /> done<br /> chmod +x filesToConvert/*.bsh<br /> for currentScript in filesToConvert/*.bsh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.bash''' script is called by the '''regenerate.bash''' script. Details about those scripts will be described later in this document. These scripts are intended for development purposes, and changes periodically have to be made to them to handle any conversions that do not succeed. This could involve anything from fixing case inconsistencies to parsing batch code that was written in an unforeseen way.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed, ed, and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new substitution commands close to the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered, but not yet in a final state. If any existing text manipulation commands are changed or new ones added, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.bash''' script.<br /> <br /> ====eXo/util/regenerate.bash====<br /> <br /> :The purpose of the '''regenerate.bash''' script is to assist in the development of future Linux and macOS patches by automating the conversion of config files and Windows batch files to their Linux and macOS equivalents. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.bash''' script as well as the '''converter.bash''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging. Version 6 added much more complexity to eXoDOS than had ever previously existed. As a result, from version 5 to version 6, these files grew over 5 and a half times in size and complexity. As time goes on, new challenges are likely to be faced for maintaining these scripts.<br /> <br /> :The '''regenerate.bash''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, and converts all of the unzipped bat, conf, and other known support files. As case inconsistencies are found, substitutions to correct the inconsistencies are manually placed into the regenerate.bash script.<br /> <br /> :Most text manipulation for the above steps is done through sed commands, although there are a few situations where ed and Perl are used instead.<br /> <br /> :In short, when executing the '''regenerate.bash''' script, it goes through the following steps:<br /> :#Gives a disclaimer that running the script will take a VERY long time<br /> :#Checks that standard eXo files are located in their expected locations in relation to the script<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Copies bat files to newly created bsh files<br /> :#Prepares bsh files for conversion<br /> :#Converts syntax for the Linux shell files (bsh) from Windows batch to bash<br /> :#Removes unnecessary dependency checks for eXoDREAMM and eXoScummVM<br /> :#Creates universal launch files for Linux and macOS (command files)<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies Linux-only backend fixes<br /> :#Applies Linux-only game specific fixes<br /> :#Converts shell script reference txt files<br /> :#Prepares macOS shell files (this step is currently skipped for eXoDOS, eXoScummVM, and eXoWin3x)<br /> :#Corrects xml inconsistencies with known solutions<br /> :#Removes unnecessary files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the case inconsistency fixes and game specific changes are manually added to the '''regenerate.bash''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Linux Flatpaks===<br /> <br /> :The following flatpaks use org.freedesktop.Platform 24.08:<br /> :* com.retro_exo.aria2c<br /> :*com.retro_exo.dosbox-staging-081-2<br /> :*com.retro_exo.dosbox-x-08220<br /> :*com.retro_exo.dosbox-x-20240701<br /> :*com.retro_exo.gzdoom-4-11-3<br /> :*com.retro_exo.mcomix<br /> :*com.retro_exo.scummvm-2-2-0<br /> :*com.retro_exo.scummvm-2-3-0-git15811-gf97bfb7ce1<br /> :The following flatpaks use org.freedesktop.Platform 23.08:<br /> :* com.retro_exo.dosbox-074r3-1<br /> :* com.retro_exo.dosbox-ece-r4301<br /> :* com.retro_exo.dosbox-ece-r4358<br /> :* com.retro_exo.dosbox-ece-r4482<br /> :* com.retro_exo.dosbox-gridc-4-3-1<br /> :* com.retro_exo.mpv<br /> :*com.retro_exo.wine<br /> :The following flatpaks use org.gnome.Platform 46:<br /> :* com.retro_exo.abiword<br /> :* com.retro_exo.gnumeric<br /> :The following flatpaks use org.kde.Platform 6.7:<br /> :* com.retro_exo.falkon<br /> :* com.retro_exo.okular<br /> ===Linux Update and Patch Files===<br /> <br /> :The Update directory is extracted from '''EXTDOS_linux.zip''' to the '''eXo/Update''' location. It contains the scripts to run the eXoDOS updater as well as subdirectories for updates and patch files. The '''eXo/Update''' directory may initially look something like the following:<br /> <pre><br /> ├── changelog.txt<br /> ├── cleanup.bat<br /> ├── cleanup.bsh<br /> ├── cleanup.command<br /> ├── !dos<br /> │ └── linux<br /> │ └── release<br /> │ ├── Battle Isle 2 (1993).zip<br /> │ ├── Breach 2 (1990).zip<br /> │ ├── Carmageddon Max Pack (1998).zip<br /> │ ├── Command and Conquer (1995).zip<br /> │ ├── Command and Conquer - Red Alert (1996).zip<br /> │ ├── Complete Great Naval Battles, The - The Final Fury (1996).zip<br /> │ ├── DOOM - eXoWAD (2021).zip<br /> │ ├── Grand Theft Auto (1997).zip<br /> │ ├── Hard Nova (1990).zip<br /> │ ├── Heroes of Might and Magic II (Deluxe Edition) (1998).zip<br /> │ ├── Jane's Combat Simulations Advanced Tactical Fighters (1996).zip<br /> │ ├── Last Half of Darkness (1989).zip<br /> │ ├── Lemmings (1991).zip<br /> │ ├── Lemmings 3 - All New World of Lemmings (1994).zip<br /> │ ├── Leo the Lion (1997).zip<br /> │ ├── Living Ball (1995).zip<br /> │ ├── Mean 18 (1986).zip<br /> │ ├── MechWarrior 2 (Limited Edition) (1996).zip<br /> │ ├── NFL Challenge (1985).zip<br /> │ ├── Normality (1996).zip<br /> │ ├── Picture Perfect Golf (1995).zip<br /> │ ├── Prisoner of Ice (1995).zip<br /> │ ├── Realms of Arkania - Blade of Destiny (1992).zip<br /> │ ├── Resurrection - Rise 2 (1996).zip<br /> │ ├── Sigil (2019).zip<br /> │ ├── Sigil II (2023).zip<br /> │ ├── Star Trek - Judgement Rites CD (1993).zip<br /> │ ├── Time Gate - Knight's Chase (1995).zip<br /> │ ├── Ultima VI - The False Prophet (1990).zip<br /> │ ├── Ultima V - Warriors of Destiny (1988).zip<br /> │ └── Zone of Artificial Resources (1997).zip<br /> ├── index.txt<br /> ├── restore.exe<br /> ├── restore.py<br /> ├── update.bat<br /> ├── update.bsh<br /> ├── update.command<br /> ├── update_installed.bat<br /> ├── update_installed.bsh<br /> ├── update_installed.command<br /> ├── update.txt<br /> ├── update_xml.bat<br /> ├── update_xml.bsh<br /> ├── update_xml.command<br /> └── ver<br /> └── ver.txt<br /> </pre><br /> <br /> :Executing the '''update.command''' script will run an update for eXoDOS. This normally will be done in exogui from the eXoDOS game entry. Both the Windows version of eXoDOS and the Linux patch download the same updates. Updates work identically regardless of the operating system.<br /> :* Files in the '''eXo/Update/!dos''' directory are for non-OS specific game file updates.<br /> :* Files in the '''eXo/Update/!dos/linux/release''' directory are Linux specific patch files that are bundled with the eXoDOS Linux patch when you download it.<br /> :* Files in the '''eXo/Update/!dos/linux''' directory are Linux specific update files that are downloaded as part of an eXoDOS update.<br /> :All files extracted from Linux specific archives have unique filenames to differentiate them from files that should only be used in Windows.<br /> :Files are extracted from these directories in the following order:<br /> :# eXo/Update/!dos<br /> :# eXo/Update/!dos/linux/release<br /> :# eXo/Update/!dos/linux<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=655 Linux Patch 2024-09-13T03:46:36Z

<p>Parricc: /* util_linux.zip */ add runtime details</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows, including both the lite and full versions. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> An add-on zip is also available as a separate download to add Linux support to the Media Pack.<br /> <br /> <nowiki>*</nowiki>Note: The German Language Pack has not yet been converted*<br /> <br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''!languagepacks/launch.bsh''' - language pack support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''!languagepacks/launch.msh''' - language pack support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''AltLauncher.bsh''' - support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''AltLauncher.msh''' - support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''EXTDOS_linux.zip''' - contains Linux flatpaks, update files, AppImages, and emulator support files (bak, bsh, command, conf, txt) <br /> :*'''alt_dosbox_linux.txt''' - defines the command to launch DOSBox for the alternate launcher (<span style="color: red">must be DOSBox Staging to not break conf files)<br /> :*'''alt_launch_linux.txt''' - defines the directory containing the DOSBox Staging resource folder used by eXoDOS for the alternate launcher<br /> :*'''converter.bash''' - support file for regenerate.bash that converts bat files to bash files using a long series of substitution commands<br /> :*'''dosbox_linux.txt''' - defines what version of DOSBox is used by each game in Linux<br /> :*'''eXoLBpm_linux.py''' - The LaunchBox Parents.xml merging tool for Linux<br /> :*'''eXoLPLBXMLedit_linux.py''' - The eXoDOS Language Pack LaunchBox XML edit tool for Linux<br /> :*'''eXoLPPPM_linux.py''' - The eXoDOS Language Pack Playlist Parents Merger tool for Linux<br /> :* '''exodos.png''' - png file that can be used as a custom icon in Steam<br /> :*'''exodosvi_cover.jpg''' - Box art image that can be used as a custom background in Steam<br /> :*'''install.bsh''' - support file for Linux game install scripts (gets called by the install.bsh script in the game directory)<br /> :*'''install.msh''' - support file for macOS game install scripts (gets called by the install.msh script in the game directory)<br /> :*'''ip.bsh''' - support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''ip.msh''' - support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''launch.bsh''' - support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''launch.msh''' - support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''regenerate.bash''' - location sensitive development script used to convert unzipped files from eXo collections to Linux and macOS<br /> :*'''version.bsh''' - Linux support file for version.command<br /> :*'''version.command''' - This tells the currently installed version of eXoDOS<br /> :*'''version.msh''' - macOS support file for version.command<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Development Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> ====eXo/util/converter.bash====<br /> : The '''converter.bash''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.bash''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.bash''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.bash''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.bash''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.bash<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.bsh"<br /> done<br /> chmod +x filesToConvert/*.bsh<br /> for currentScript in filesToConvert/*.bsh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.bash''' script is called by the '''regenerate.bash''' script. Details about those scripts will be described later in this document. These scripts are intended for development purposes, and changes periodically have to be made to them to handle any conversions that do not succeed. This could involve anything from fixing case inconsistencies to parsing batch code that was written in an unforeseen way.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed, ed, and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new substitution commands close to the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered, but not yet in a final state. If any existing text manipulation commands are changed or new ones added, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.bash''' script.<br /> <br /> ====eXo/util/regenerate.bash====<br /> <br /> :The purpose of the '''regenerate.bash''' script is to assist in the development of future Linux and macOS patches by automating the conversion of config files and Windows batch files to their Linux and macOS equivalents. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.bash''' script as well as the '''converter.bash''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging. Version 6 added much more complexity to eXoDOS than had ever previously existed. As a result, from version 5 to version 6, these files grew over 5 and a half times in size and complexity. As time goes on, new challenges are likely to be faced for maintaining these scripts.<br /> <br /> :The '''regenerate.bash''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, and converts all of the unzipped bat, conf, and other known support files. As case inconsistencies are found, substitutions to correct the inconsistencies are manually placed into the regenerate.bash script.<br /> <br /> :Most text manipulation for the above steps is done through sed commands, although there are a few situations where ed and Perl are used instead.<br /> <br /> :In short, when executing the '''regenerate.bash''' script, it goes through the following steps:<br /> :#Gives a disclaimer that running the script will take a VERY long time<br /> :#Checks that standard eXo files are located in their expected locations in relation to the script<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Copies bat files to newly created bsh files<br /> :#Prepares bsh files for conversion<br /> :#Converts syntax for the Linux shell files (bsh) from Windows batch to bash<br /> :#Removes unnecessary dependency checks for eXoDREAMM and eXoScummVM<br /> :#Creates universal launch files for Linux and macOS (command files)<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies Linux-only backend fixes<br /> :#Applies Linux-only game specific fixes<br /> :#Converts shell script reference txt files<br /> :#Prepares macOS shell files (this step is currently skipped for eXoDOS, eXoScummVM, and eXoWin3x)<br /> :#Corrects xml inconsistencies with known solutions<br /> :#Removes unnecessary files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the case inconsistency fixes and game specific changes are manually added to the '''regenerate.bash''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Linux Flatpaks===<br /> <br /> :The following flatpaks use org.freedesktop.Platform 23.08:<br /> :* com.retro_exo.wine<br /> :* com.retro_exo.mpv<br /> :* com.retro_exo.dosbox-074r3-1<br /> :* com.retro_exo.dosbox-gridc-4-3-1<br /> :* com.retro_exo.dosbox-ece-r4301<br /> :* com.retro_exo.dosbox-ece-r4358<br /> :* com.retro_exo.dosbox-ece-r4482<br /> :The following flatpaks use<br /> ===Linux Update and Patch Files===<br /> <br /> :The Update directory is extracted from '''EXTDOS_linux.zip''' to the '''eXo/Update''' location. It contains the scripts to run the eXoDOS updater as well as subdirectories for updates and patch files. The '''eXo/Update''' directory may initially look something like the following:<br /> <pre><br /> ├── changelog.txt<br /> ├── cleanup.bat<br /> ├── cleanup.bsh<br /> ├── cleanup.command<br /> ├── !dos<br /> │ └── linux<br /> │ └── release<br /> │ ├── Battle Isle 2 (1993).zip<br /> │ ├── Breach 2 (1990).zip<br /> │ ├── Carmageddon Max Pack (1998).zip<br /> │ ├── Command and Conquer (1995).zip<br /> │ ├── Command and Conquer - Red Alert (1996).zip<br /> │ ├── Complete Great Naval Battles, The - The Final Fury (1996).zip<br /> │ ├── DOOM - eXoWAD (2021).zip<br /> │ ├── Grand Theft Auto (1997).zip<br /> │ ├── Hard Nova (1990).zip<br /> │ ├── Heroes of Might and Magic II (Deluxe Edition) (1998).zip<br /> │ ├── Jane's Combat Simulations Advanced Tactical Fighters (1996).zip<br /> │ ├── Last Half of Darkness (1989).zip<br /> │ ├── Lemmings (1991).zip<br /> │ ├── Lemmings 3 - All New World of Lemmings (1994).zip<br /> │ ├── Leo the Lion (1997).zip<br /> │ ├── Living Ball (1995).zip<br /> │ ├── Mean 18 (1986).zip<br /> │ ├── MechWarrior 2 (Limited Edition) (1996).zip<br /> │ ├── NFL Challenge (1985).zip<br /> │ ├── Normality (1996).zip<br /> │ ├── Picture Perfect Golf (1995).zip<br /> │ ├── Prisoner of Ice (1995).zip<br /> │ ├── Realms of Arkania - Blade of Destiny (1992).zip<br /> │ ├── Resurrection - Rise 2 (1996).zip<br /> │ ├── Sigil (2019).zip<br /> │ ├── Sigil II (2023).zip<br /> │ ├── Star Trek - Judgement Rites CD (1993).zip<br /> │ ├── Time Gate - Knight's Chase (1995).zip<br /> │ ├── Ultima VI - The False Prophet (1990).zip<br /> │ ├── Ultima V - Warriors of Destiny (1988).zip<br /> │ └── Zone of Artificial Resources (1997).zip<br /> ├── index.txt<br /> ├── restore.exe<br /> ├── restore.py<br /> ├── update.bat<br /> ├── update.bsh<br /> ├── update.command<br /> ├── update_installed.bat<br /> ├── update_installed.bsh<br /> ├── update_installed.command<br /> ├── update.txt<br /> ├── update_xml.bat<br /> ├── update_xml.bsh<br /> ├── update_xml.command<br /> └── ver<br /> └── ver.txt<br /> </pre><br /> <br /> :Executing the '''update.command''' script will run an update for eXoDOS. This normally will be done in exogui from the eXoDOS game entry. Both the Windows version of eXoDOS and the Linux patch download the same updates. Updates work identically regardless of the operating system.<br /> :* Files in the '''eXo/Update/!dos''' directory are for non-OS specific game file updates.<br /> :* Files in the '''eXo/Update/!dos/linux/release''' directory are Linux specific patch files that are bundled with the eXoDOS Linux patch when you download it.<br /> :* Files in the '''eXo/Update/!dos/linux''' directory are Linux specific update files that are downloaded as part of an eXoDOS update.<br /> :All files extracted from Linux specific archives have unique filenames to differentiate them from files that should only be used in Windows.<br /> :Files are extracted from these directories in the following order:<br /> :# eXo/Update/!dos<br /> :# eXo/Update/!dos/linux/release<br /> :# eXo/Update/!dos/linux<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=654 Linux Patch 2024-09-12T23:00:14Z

<p>Parricc: /* Overview */ Add overview references to the lite version, media pack, and GLP.</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows, including both the lite and full versions. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> An add-on zip is also available as a separate download to add Linux support to the Media Pack.<br /> <br /> <nowiki>*</nowiki>Note: The German Language Pack has not yet been converted*<br /> <br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''!languagepacks/launch.bsh''' - language pack support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''!languagepacks/launch.msh''' - language pack support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''AltLauncher.bsh''' - support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''AltLauncher.msh''' - support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''EXTDOS_linux.zip''' - contains Linux flatpaks, update files, AppImages, and emulator support files (bak, bsh, command, conf, txt) <br /> :*'''alt_dosbox_linux.txt''' - defines the command to launch DOSBox for the alternate launcher (<span style="color: red">must be DOSBox Staging to not break conf files)<br /> :*'''alt_launch_linux.txt''' - defines the directory containing the DOSBox Staging resource folder used by eXoDOS for the alternate launcher<br /> :*'''converter.bash''' - support file for regenerate.bash that converts bat files to bash files using a long series of substitution commands<br /> :*'''dosbox_linux.txt''' - defines what version of DOSBox is used by each game in Linux<br /> :*'''eXoLBpm_linux.py''' - The LaunchBox Parents.xml merging tool for Linux<br /> :*'''eXoLPLBXMLedit_linux.py''' - The eXoDOS Language Pack LaunchBox XML edit tool for Linux<br /> :*'''eXoLPPPM_linux.py''' - The eXoDOS Language Pack Playlist Parents Merger tool for Linux<br /> :* '''exodos.png''' - png file that can be used as a custom icon in Steam<br /> :*'''exodosvi_cover.jpg''' - Box art image that can be used as a custom background in Steam<br /> :*'''install.bsh''' - support file for Linux game install scripts (gets called by the install.bsh script in the game directory)<br /> :*'''install.msh''' - support file for macOS game install scripts (gets called by the install.msh script in the game directory)<br /> :*'''ip.bsh''' - support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''ip.msh''' - support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''launch.bsh''' - support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''launch.msh''' - support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''regenerate.bash''' - location sensitive development script used to convert unzipped files from eXo collections to Linux and macOS<br /> :*'''version.bsh''' - Linux support file for version.command<br /> :*'''version.command''' - This tells the currently installed version of eXoDOS<br /> :*'''version.msh''' - macOS support file for version.command<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Development Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> ====eXo/util/converter.bash====<br /> : The '''converter.bash''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.bash''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.bash''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.bash''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.bash''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.bash<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.bsh"<br /> done<br /> chmod +x filesToConvert/*.bsh<br /> for currentScript in filesToConvert/*.bsh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.bash''' script is called by the '''regenerate.bash''' script. Details about those scripts will be described later in this document. These scripts are intended for development purposes, and changes periodically have to be made to them to handle any conversions that do not succeed. This could involve anything from fixing case inconsistencies to parsing batch code that was written in an unforeseen way.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed, ed, and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new substitution commands close to the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered, but not yet in a final state. If any existing text manipulation commands are changed or new ones added, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.bash''' script.<br /> <br /> ====eXo/util/regenerate.bash====<br /> <br /> :The purpose of the '''regenerate.bash''' script is to assist in the development of future Linux and macOS patches by automating the conversion of config files and Windows batch files to their Linux and macOS equivalents. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.bash''' script as well as the '''converter.bash''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging. Version 6 added much more complexity to eXoDOS than had ever previously existed. As a result, from version 5 to version 6, these files grew over 5 and a half times in size and complexity. As time goes on, new challenges are likely to be faced for maintaining these scripts.<br /> <br /> :The '''regenerate.bash''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, and converts all of the unzipped bat, conf, and other known support files. As case inconsistencies are found, substitutions to correct the inconsistencies are manually placed into the regenerate.bash script.<br /> <br /> :Most text manipulation for the above steps is done through sed commands, although there are a few situations where ed and Perl are used instead.<br /> <br /> :In short, when executing the '''regenerate.bash''' script, it goes through the following steps:<br /> :#Gives a disclaimer that running the script will take a VERY long time<br /> :#Checks that standard eXo files are located in their expected locations in relation to the script<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Copies bat files to newly created bsh files<br /> :#Prepares bsh files for conversion<br /> :#Converts syntax for the Linux shell files (bsh) from Windows batch to bash<br /> :#Removes unnecessary dependency checks for eXoDREAMM and eXoScummVM<br /> :#Creates universal launch files for Linux and macOS (command files)<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies Linux-only backend fixes<br /> :#Applies Linux-only game specific fixes<br /> :#Converts shell script reference txt files<br /> :#Prepares macOS shell files (this step is currently skipped for eXoDOS, eXoScummVM, and eXoWin3x)<br /> :#Corrects xml inconsistencies with known solutions<br /> :#Removes unnecessary files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the case inconsistency fixes and game specific changes are manually added to the '''regenerate.bash''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Linux Update and Patch Files===<br /> <br /> :The Update directory is extracted from '''EXTDOS_linux.zip''' to the '''eXo/Update''' location. It contains the scripts to run the eXoDOS updater as well as subdirectories for updates and patch files. The '''eXo/Update''' directory may initially look something like the following:<br /> <pre><br /> ├── changelog.txt<br /> ├── cleanup.bat<br /> ├── cleanup.bsh<br /> ├── cleanup.command<br /> ├── !dos<br /> │ └── linux<br /> │ └── release<br /> │ ├── Battle Isle 2 (1993).zip<br /> │ ├── Breach 2 (1990).zip<br /> │ ├── Carmageddon Max Pack (1998).zip<br /> │ ├── Command and Conquer (1995).zip<br /> │ ├── Command and Conquer - Red Alert (1996).zip<br /> │ ├── Complete Great Naval Battles, The - The Final Fury (1996).zip<br /> │ ├── DOOM - eXoWAD (2021).zip<br /> │ ├── Grand Theft Auto (1997).zip<br /> │ ├── Hard Nova (1990).zip<br /> │ ├── Heroes of Might and Magic II (Deluxe Edition) (1998).zip<br /> │ ├── Jane's Combat Simulations Advanced Tactical Fighters (1996).zip<br /> │ ├── Last Half of Darkness (1989).zip<br /> │ ├── Lemmings (1991).zip<br /> │ ├── Lemmings 3 - All New World of Lemmings (1994).zip<br /> │ ├── Leo the Lion (1997).zip<br /> │ ├── Living Ball (1995).zip<br /> │ ├── Mean 18 (1986).zip<br /> │ ├── MechWarrior 2 (Limited Edition) (1996).zip<br /> │ ├── NFL Challenge (1985).zip<br /> │ ├── Normality (1996).zip<br /> │ ├── Picture Perfect Golf (1995).zip<br /> │ ├── Prisoner of Ice (1995).zip<br /> │ ├── Realms of Arkania - Blade of Destiny (1992).zip<br /> │ ├── Resurrection - Rise 2 (1996).zip<br /> │ ├── Sigil (2019).zip<br /> │ ├── Sigil II (2023).zip<br /> │ ├── Star Trek - Judgement Rites CD (1993).zip<br /> │ ├── Time Gate - Knight's Chase (1995).zip<br /> │ ├── Ultima VI - The False Prophet (1990).zip<br /> │ ├── Ultima V - Warriors of Destiny (1988).zip<br /> │ └── Zone of Artificial Resources (1997).zip<br /> ├── index.txt<br /> ├── restore.exe<br /> ├── restore.py<br /> ├── update.bat<br /> ├── update.bsh<br /> ├── update.command<br /> ├── update_installed.bat<br /> ├── update_installed.bsh<br /> ├── update_installed.command<br /> ├── update.txt<br /> ├── update_xml.bat<br /> ├── update_xml.bsh<br /> ├── update_xml.command<br /> └── ver<br /> └── ver.txt<br /> </pre><br /> <br /> :Executing the '''update.command''' script will run an update for eXoDOS. This normally will be done in exogui from the eXoDOS game entry. Both the Windows version of eXoDOS and the Linux patch download the same updates. Updates work identically regardless of the operating system.<br /> :* Files in the '''eXo/Update/!dos''' directory are for non-OS specific game file updates.<br /> :* Files in the '''eXo/Update/!dos/linux/release''' directory are Linux specific patch files that are bundled with the eXoDOS Linux patch when you download it.<br /> :* Files in the '''eXo/Update/!dos/linux''' directory are Linux specific update files that are downloaded as part of an eXoDOS update.<br /> :All files extracted from Linux specific archives have unique filenames to differentiate them from files that should only be used in Windows.<br /> :Files are extracted from these directories in the following order:<br /> :# eXo/Update/!dos<br /> :# eXo/Update/!dos/linux/release<br /> :# eXo/Update/!dos/linux<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Main_Page&diff=653 Main Page 2024-09-12T01:58:43Z

<p>Parricc: Added section for Linux patch</p> <hr /> <div>= <div style="text-align:center;">[[File:RetroeXo Logo.png]]<br>'''Retro eXo'''</div> =<br /> <strong>Project Goal</strong><br><br /> The eXo projects' goal is preservation through playability.<br><br /> <br /> <strong>Project Resources</strong><br><br /> '''[http://www.retro-exo.com www.retro-exo.com]''': Project Homepage.<br><br /> '''[https://www.youtube.com/c/eXoRetro YouTube Channel]''': Various videos about the project and how to use it.<br><br /> '''[https://discord.gg/37FYaUZ Discord]''': Project discussion, chat, & community.<br><br /> '''[https://github.com/exoscoriae/ Github]''': Bugs, submissions, and enhancements are tracked here.<br><br /> <br /> == Projects ==<br /> === Current ===<br /> ==== [[EXODOS]] ====<br /> <small>Current Version: eXoDOS v5<br><br /> Release Date: October 31st, 2020<br><br /> Number of Games: 7,200<br><br /> Upcoming Version: eXoDOS v6, ETA 2023<br><br /> </small><br><br /> ==== [[EXOWin3x]] ====<br /> <small>Current Version: eXoWin3x v2<br><br /> Release Date: February 14th, 2021<br><br /> Number of Games: 1,138<br><br /> Upcoming Version: eXoWin3x v3, ETA 2024<br><br /> </small><br><br /> ==== [[EXOScummVM]] ====<br /> <small>Current Version: eXoScummVM r2.2.0<br><br /> Release Date: June 20th, 2021<br><br /> Number of Games: 387 unique titles, multiple variations of each<br><br /> Upcoming Version: TBD<br><br /> </small><br><br /> ==== [[EXORLP]] ====<br /> <small>Current Version: eXo's Retro Learning Pack<br><br /> Release Date: April 1st, 2020<br><br /> Number of Games: 667 titles, compiled from eXoDOS and eXoWin3x<br><br /> 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<br><br /> </small><br><br /> <br /> === Future ===<br /> ==== EXOWin9x ====<br /> <small>Current Version: None<br><br /> Release Date: ?<br><br /> Number of Games: ?<br><br /> Upcoming Version: ETA Unknown. Depends on progress in emulation<br><br /> </small><br><br /> ==== Secret ====<br /> <small>Current Version: None<br><br /> Release Date: ?<br><br /> Number of Games: ?<br><br /> Upcoming Version: ETA 2022<br><br /> </small><br><br /> <br /> == History ==<br /> 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.<br><br><br /> 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.<br><br><br /> 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.<br><br><br /> 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.<br><br><br /> 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].<br /> <br /> == Media ==<br /> The project and/or creator have been featured in the following articles:<br /> <br /> [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]<br><br /> [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.]<br><br /> [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]<br><br /> <br /> == Technical Information ==<br /> === Emulated Hardware ===<br /> [[3Dfx]]<br><br /> [[Sound Cards]]<br><br /> [[Video Modes]]<br><br /> [[Remote Multiplayer]]<br><br /> <br /> === Common Core Systems ===<br /> [[Project Setup]]<br><br /> [[Installer]]<br><br /> [[Launcher]]<br><br /> [[DOSBox Configuration File]]<br><br /> [[Updater]]<br><br /> [[Downloader]]<br><br /> [[EXO Plugin]]<br><br /> <br /> ==== Emulators ====<br /> [[DOSBox]]<br><br /> [https://wiki.scummvm.org/index.php?title=Main_Page ScummVM]<br><br /> <br /> === Unique Modules ===<br /> [[Gold Box Companion]]<br><br /> [[All-Seeing Eye]]<br><br /> [[Ultimapper 5]]<br><br /> <br /> === Metadata ===<br /> [[Images]]<br><br /> [[LaunchBox Platform XML]]<br><br /> [[Interactive Code Wheels]]<br><br /> [[Manuals]]<br><br /> [[Magazines]]<br><br /> [[Music]]<br><br /> [[Playlists]]<br><br /> [[Save Game Transfer]]<br><br /> [[Video Snaps]]<br><br /> <br /> === Database ===<br /> [[Master Database]]<br><br /> <br /> == Game Specific Projects ==<br /> DOOM - [[EXOWAD]]<br><br /> ZZT - [[EXOZZT]]<br><br /> [[Unlimited Adventures]]<br /> <br /> == Language Packs ==<br /> <br /> [[The Language Pack Concept]]<br /> <br /> ==== In Progress: ====<br /> [[French Language Pack]]<br><br /> [[German Language Pack]]<br><br /> <br /> ==== On Hold: ====<br /> Polish Language Pack<br><br /> <br /> ==== In need of a curator ====<br /> Chinese Language Pack<br><br /> Italian Language Pack<br><br /> Korean Language Pack<br><br /> Russian Language Pack<br><br /> Spanish Language Pack<br><br /> <br><br /> <small>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.</small><br /> <br /> == Linux Patch ==<br /> [[Linux Patch|eXoDOS 6.4 Linux Patch]]<br /> <br /> == FAQ ==<br /> For a list of frequently asked questions, please visit the [https://www.retro-exo.com/FAQ.html website FAQ].<br /> <br /> == Contact ==<br /> <br /> If you would like to contribute, please contact [[User:EXO|EXO]] for registration.<br /> <br /> <br /> <br /> <br /> <br /> </div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=652 Linux Patch 2024-09-12T01:29:42Z

<p>Parricc: Finished updating document for eXoDOS 6.</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''!languagepacks/launch.bsh''' - language pack support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''!languagepacks/launch.msh''' - language pack support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''AltLauncher.bsh''' - support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''AltLauncher.msh''' - support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''EXTDOS_linux.zip''' - contains Linux flatpaks, update files, AppImages, and emulator support files (bak, bsh, command, conf, txt) <br /> :*'''alt_dosbox_linux.txt''' - defines the command to launch DOSBox for the alternate launcher (<span style="color: red">must be DOSBox Staging to not break conf files)<br /> :*'''alt_launch_linux.txt''' - defines the directory containing the DOSBox Staging resource folder used by eXoDOS for the alternate launcher<br /> :*'''converter.bash''' - support file for regenerate.bash that converts bat files to bash files using a long series of substitution commands<br /> :*'''dosbox_linux.txt''' - defines what version of DOSBox is used by each game in Linux<br /> :*'''eXoLBpm_linux.py''' - The LaunchBox Parents.xml merging tool for Linux<br /> :*'''eXoLPLBXMLedit_linux.py''' - The eXoDOS Language Pack LaunchBox XML edit tool for Linux<br /> :*'''eXoLPPPM_linux.py''' - The eXoDOS Language Pack Playlist Parents Merger tool for Linux<br /> :* '''exodos.png''' - png file that can be used as a custom icon in Steam<br /> :*'''exodosvi_cover.jpg''' - Box art image that can be used as a custom background in Steam<br /> :*'''install.bsh''' - support file for Linux game install scripts (gets called by the install.bsh script in the game directory)<br /> :*'''install.msh''' - support file for macOS game install scripts (gets called by the install.msh script in the game directory)<br /> :*'''ip.bsh''' - support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''ip.msh''' - support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''launch.bsh''' - support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''launch.msh''' - support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''regenerate.bash''' - location sensitive development script used to convert unzipped files from eXo collections to Linux and macOS<br /> :*'''version.bsh''' - Linux support file for version.command<br /> :*'''version.command''' - This tells the currently installed version of eXoDOS<br /> :*'''version.msh''' - macOS support file for version.command<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Development Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> ====eXo/util/converter.bash====<br /> : The '''converter.bash''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.bash''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.bash''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.bash''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.bash''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.bash<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.bsh"<br /> done<br /> chmod +x filesToConvert/*.bsh<br /> for currentScript in filesToConvert/*.bsh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.bash''' script is called by the '''regenerate.bash''' script. Details about those scripts will be described later in this document. These scripts are intended for development purposes, and changes periodically have to be made to them to handle any conversions that do not succeed. This could involve anything from fixing case inconsistencies to parsing batch code that was written in an unforeseen way.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed, ed, and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new substitution commands close to the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered, but not yet in a final state. If any existing text manipulation commands are changed or new ones added, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.bash''' script.<br /> <br /> ====eXo/util/regenerate.bash====<br /> <br /> :The purpose of the '''regenerate.bash''' script is to assist in the development of future Linux and macOS patches by automating the conversion of config files and Windows batch files to their Linux and macOS equivalents. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.bash''' script as well as the '''converter.bash''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging. Version 6 added much more complexity to eXoDOS than had ever previously existed. As a result, from version 5 to version 6, these files grew over 5 and a half times in size and complexity. As time goes on, new challenges are likely to be faced for maintaining these scripts.<br /> <br /> :The '''regenerate.bash''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, and converts all of the unzipped bat, conf, and other known support files. As case inconsistencies are found, substitutions to correct the inconsistencies are manually placed into the regenerate.bash script.<br /> <br /> :Most text manipulation for the above steps is done through sed commands, although there are a few situations where ed and Perl are used instead.<br /> <br /> :In short, when executing the '''regenerate.bash''' script, it goes through the following steps:<br /> :#Gives a disclaimer that running the script will take a VERY long time<br /> :#Checks that standard eXo files are located in their expected locations in relation to the script<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Copies bat files to newly created bsh files<br /> :#Prepares bsh files for conversion<br /> :#Converts syntax for the Linux shell files (bsh) from Windows batch to bash<br /> :#Removes unnecessary dependency checks for eXoDREAMM and eXoScummVM<br /> :#Creates universal launch files for Linux and macOS (command files)<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies Linux-only backend fixes<br /> :#Applies Linux-only game specific fixes<br /> :#Converts shell script reference txt files<br /> :#Prepares macOS shell files (this step is currently skipped for eXoDOS, eXoScummVM, and eXoWin3x)<br /> :#Corrects xml inconsistencies with known solutions<br /> :#Removes unnecessary files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the case inconsistency fixes and game specific changes are manually added to the '''regenerate.bash''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Linux Update and Patch Files===<br /> <br /> :The Update directory is extracted from '''EXTDOS_linux.zip''' to the '''eXo/Update''' location. It contains the scripts to run the eXoDOS updater as well as subdirectories for updates and patch files. The '''eXo/Update''' directory may initially look something like the following:<br /> <pre><br /> ├── changelog.txt<br /> ├── cleanup.bat<br /> ├── cleanup.bsh<br /> ├── cleanup.command<br /> ├── !dos<br /> │ └── linux<br /> │ └── release<br /> │ ├── Battle Isle 2 (1993).zip<br /> │ ├── Breach 2 (1990).zip<br /> │ ├── Carmageddon Max Pack (1998).zip<br /> │ ├── Command and Conquer (1995).zip<br /> │ ├── Command and Conquer - Red Alert (1996).zip<br /> │ ├── Complete Great Naval Battles, The - The Final Fury (1996).zip<br /> │ ├── DOOM - eXoWAD (2021).zip<br /> │ ├── Grand Theft Auto (1997).zip<br /> │ ├── Hard Nova (1990).zip<br /> │ ├── Heroes of Might and Magic II (Deluxe Edition) (1998).zip<br /> │ ├── Jane's Combat Simulations Advanced Tactical Fighters (1996).zip<br /> │ ├── Last Half of Darkness (1989).zip<br /> │ ├── Lemmings (1991).zip<br /> │ ├── Lemmings 3 - All New World of Lemmings (1994).zip<br /> │ ├── Leo the Lion (1997).zip<br /> │ ├── Living Ball (1995).zip<br /> │ ├── Mean 18 (1986).zip<br /> │ ├── MechWarrior 2 (Limited Edition) (1996).zip<br /> │ ├── NFL Challenge (1985).zip<br /> │ ├── Normality (1996).zip<br /> │ ├── Picture Perfect Golf (1995).zip<br /> │ ├── Prisoner of Ice (1995).zip<br /> │ ├── Realms of Arkania - Blade of Destiny (1992).zip<br /> │ ├── Resurrection - Rise 2 (1996).zip<br /> │ ├── Sigil (2019).zip<br /> │ ├── Sigil II (2023).zip<br /> │ ├── Star Trek - Judgement Rites CD (1993).zip<br /> │ ├── Time Gate - Knight's Chase (1995).zip<br /> │ ├── Ultima VI - The False Prophet (1990).zip<br /> │ ├── Ultima V - Warriors of Destiny (1988).zip<br /> │ └── Zone of Artificial Resources (1997).zip<br /> ├── index.txt<br /> ├── restore.exe<br /> ├── restore.py<br /> ├── update.bat<br /> ├── update.bsh<br /> ├── update.command<br /> ├── update_installed.bat<br /> ├── update_installed.bsh<br /> ├── update_installed.command<br /> ├── update.txt<br /> ├── update_xml.bat<br /> ├── update_xml.bsh<br /> ├── update_xml.command<br /> └── ver<br /> └── ver.txt<br /> </pre><br /> <br /> :Executing the '''update.command''' script will run an update for eXoDOS. This normally will be done in exogui from the eXoDOS game entry. Both the Windows version of eXoDOS and the Linux patch download the same updates. Updates work identically regardless of the operating system.<br /> :* Files in the '''eXo/Update/!dos''' directory are for non-OS specific game file updates.<br /> :* Files in the '''eXo/Update/!dos/linux/release''' directory are Linux specific patch files that are bundled with the eXoDOS Linux patch when you download it.<br /> :* Files in the '''eXo/Update/!dos/linux''' directory are Linux specific update files that are downloaded as part of an eXoDOS update.<br /> :All files extracted from Linux specific archives have unique filenames to differentiate them from files that should only be used in Windows.<br /> :Files are extracted from these directories in the following order:<br /> :# eXo/Update/!dos<br /> :# eXo/Update/!dos/linux/release<br /> :# eXo/Update/!dos/linux<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=651 Linux Patch 2024-09-12T00:51:40Z

<p>Parricc: Added more updates for eXoDOS 6.</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''!languagepacks/launch.bsh''' - language pack support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''!languagepacks/launch.msh''' - language pack support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''AltLauncher.bsh''' - support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''AltLauncher.msh''' - support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''EXTDOS_linux.zip''' - contains Linux flatpaks, update files, AppImages, and emulator support files (bak, bsh, command, conf, txt) <br /> :*'''alt_dosbox_linux.txt''' - defines the command to launch DOSBox for the alternate launcher (<span style="color: red">must be DOSBox Staging to not break conf files)<br /> :*'''alt_launch_linux.txt''' - defines the directory containing the DOSBox Staging resource folder used by eXoDOS for the alternate launcher<br /> :*'''converter.bash''' - support file for regenerate.bash that converts bat files to bash files using a long series of substitution commands<br /> :*'''dosbox_linux.txt''' - defines what version of DOSBox is used by each game in Linux<br /> :*'''eXoLBpm_linux.py''' - The LaunchBox Parents.xml merging tool for Linux<br /> :*'''eXoLPLBXMLedit_linux.py''' - The eXoDOS Language Pack LaunchBox XML edit tool for Linux<br /> :*'''eXoLPPPM_linux.py''' - The eXoDOS Language Pack Playlist Parents Merger tool for Linux<br /> :* '''exodos.png''' - png file that can be used as a custom icon in Steam<br /> :*'''exodosvi_cover.jpg''' - Box art image that can be used as a custom background in Steam<br /> :*'''install.bsh''' - support file for Linux game install scripts (gets called by the install.bsh script in the game directory)<br /> :*'''install.msh''' - support file for macOS game install scripts (gets called by the install.msh script in the game directory)<br /> :*'''ip.bsh''' - support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''ip.msh''' - support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''launch.bsh''' - support file to launch games in Linux (called by the <game name>.bsh script in the game directory)<br /> :*'''launch.msh''' - support file to launch games in macOS (called by the <game name>.msh script in the game directory)<br /> :*'''regenerate.bash''' - location sensitive development script used to convert unzipped files from eXo collections to Linux and macOS<br /> :*'''version.bsh''' - Linux support file for version.command<br /> :*'''version.command''' - This tells the currently installed version of eXoDOS<br /> :*'''version.msh''' - macOS support file for version.command<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Custom Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> ====eXo/util/converter.bash====<br /> : The '''converter.bash''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.bash''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.bash''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.bash''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.bash''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.bash<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.bsh"<br /> done<br /> chmod +x filesToConvert/*.bsh<br /> for currentScript in filesToConvert/*.bsh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.bash''' script is called by the '''regenerate.bash''' script. Details about those scripts will be described later in this document. These scripts are intended for development purposes, and changes periodically have to be made to them to handle any conversions that do not succeed. This could involve anything from fixing case inconsistencies to parsing batch code that was written in an unforeseen way.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed, ed, and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new substitution commands close to the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered, but not yet in a final state. If any existing text manipulation commands are changed or new ones added, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.bash''' script.<br /> <br /> ====eXo/util/regenerate.bash====<br /> <br /> :The purpose of the '''regenerate.bash''' script is to assist in the development of future Linux and macOS patches by automating the conversion of config files and Windows batch files to their Linux and macOS equivalents. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.bash''' script as well as the '''converter.bash''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging. Version 6 added much more complexity to eXoDOS than had ever previously existed. As a result, from version 5 to version 6, these files grew over 5 and a half times in size and complexity. As time goes on, new challenges are likely to be faced for maintaining these scripts.<br /> <br /> :The '''regenerate.bash''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, and converts all of the unzipped bat, conf, and other known support files. As case inconsistencies are found, substitutions to correct the inconsistencies are manually placed into the regenerate.bash script.<br /> <br /> :Most text manipulation for the above steps is done through sed commands, although there are a few situations where ed and Perl are used instead.<br /> <br /> :In short, when executing the '''regenerate.bash''' script, it goes through the following steps:<br /> :#Gives a disclaimer that running the script will take a VERY long time<br /> :#Checks that standard eXo files are located in their expected locations in relation to the script<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Copies bat files to newly created bsh files<br /> :#Prepares bsh files for conversion<br /> :#Converts syntax for the Linux shell files (bsh) from Windows batch to bash<br /> :#Removes unnecessary dependency checks for eXoDREAMM and eXoScummVM<br /> :#Creates universal launch files for Linux and macOS (command files)<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies Linux-only backend fixes<br /> :#Applies Linux-only game specific fixes<br /> :#Converts shell script reference txt files<br /> :#Prepares macOS shell files (this step is currently skipped for eXoDOS, eXoScummVM, and eXoWin3x)<br /> :#Corrects xml inconsistencies with known solutions<br /> :#Removes unnecessary files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the case inconsistency fixes and game specific changes are manually added to the '''regenerate.bash''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Note on Updates===<br /> <br /> :<span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> :In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> :<span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=650 Linux Patch 2024-09-11T22:32:41Z

<p>Parricc: /* Using eXoDOS */ WIP to update for eXoDOS 6</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :The official Linux frontend is exogui, a fork of Flashpoint Launcher. A member of our Discord, jelcynek, created exogui and has continued to maintain it over the years. More recently, Colin, the main Flashpoint Launcher developer, has also contributed to exogui. Together, they have made a very solid frontend. We are still looking for more volunteers to improve the UI experience, especially on the Steam Deck.<br /> :Simply double-click on the '''eXoDOS''' desktop icon, or execute the '''exogui.command''' file to launch the frontend. You will be presented with a list of all included games.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will be given an option to keep your saved games. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler.<br /> :<br /> :To launch a game or its setup from exogui, click on the game to select it, and then click on the 'Install', 'Play', or 'Setup' button in the right-hand pane.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a specific game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes to the Exec, Icon, and Name lines as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Encoding=UTF-8<br /> Version=1.0<br /> Type=Application<br /> Terminal=false<br /> Exec="/home/username/eXoDOS/eXo/eXoDOS/!dos/mi1/Secret of Monkey Island, The (1990).command"<br /> Icon=/usr/share/icons/Some Monkey Island Icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to the eXoDOS 6.04 Linux Patch====<br /> <br /> :*Launch scripts directly from any file-manager: Files ending in the *.command extension can be launched directly from any file manager.<br /> :*Revamped dependency installer with update support: For many distributions, sudo access is no longer needed.<br /> :*Improved compatibility: The eXoDOS Linux patch will now run on virtually any x86_64 distro with flatpak support, including the Steam Deck.<br /> :*Improved frontend: The exogui frontend is now feature packed with full support for extras, filters, images, playlists, and videos.<br /> :*Improved backend: The backend has been completely revamped to include all eXoDOS 6 features.<br /> :*Bug Squash: Hundreds of previously broken games have been fixed after thorough testing<br /> <br /> ===Files===<br /> <br /> ====eXoDOS 6.4 Linux Patch.zip====<br /> :'''eXoDOS 6.4 Linux Patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOS_linux_metadata.zip<br /> │ └── XODOS_linux_Metadata.zip<br /> ├── eXo<br /> │ └── util<br /> │ ├── eXoMerge.bsh<br /> │ ├── install_dependencies.bsh<br /> │ ├── Setup eXoDOS.bsh<br /> │ └── utilDOS_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── eXoMerge.command<br /> ├── install_dependencies.command<br /> └── Setup eXoDOS.command<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS.<br /> :*'''Content/!DOS_linux_metadata.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (bsh, command, conf) for games.<br /> :*'''Content/XODOS_linux_Metadata.zip''' - This contains the exogui files and some xml scripts.<br /> :*'''eXo/util/eXoMerge.bsh''' - This is a support file for eXoMerge.command.<br /> :*'''eXo/util/install_dependencies.bsh''' - This is a support file for install_dependencies.command.<br /> :*'''eXo/util/Setup eXoDOS.bsh''' - This is a support file for Setup eXoDOS.command.<br /> :*'''eXo/util/utilDOS_linux.zip''' - This contains the eXoDOS Linux backend files.<br /> :*'''eXoMerge.command''' - This script is used to help merge two eXo collections that have already been instal<span style="color: red">'''<span style="color: red">'''led.<br /> :* '''install_dependencies.command''' - This launches the Linux/macOS setup to <span style="color: red">'''<span style="color: red">'''install system dependencies needed for eXo collections.<br /> :*'''Setup eXoDOS.command''' - This launches the Linux/macOS setup for eXoDOS. While you cannot currently run eXoDOS on macOS, you can still install it for other systems.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''!english/texts_linux.txt''' - support file for the eXoDOS Updater<br /> :*'''!languagepacks/Alternate Launcher.bsh''' - language pack support file for Linux alternate launcher (called by bsh script in the game Extras directory)<br /> :*'''!languagepacks/Alternate Launcher.msh''' - language pack support file for macOS alternate launcher (called by msh script in the game Extras directory)<br /> :*'''!languagepacks/install.bsh''' - language pack support file for Linux game installer (called by bsh script in game directory)<br /> :*'''!languagepacks/install.msh''' - language pack support file for macOS game installer (called by msh script in game directory)<br /> :*'''!languagepacks/ip.bsh''' - language pack support file to determine IP address for multiplayer games in Linux (called by the launch.bsh script in the same directory)<br /> :*'''!languagepacks/ip.msh''' - language pack support file to determine IP address for multiplayer games in macOS (called by the launch.msh script in the same directory)<br /> :*'''Sumatra/CallSumatra.bsh''' - Linux support file for CallSumatra.command<br /> :*'''Sumatra/CallSumatra.command''' - exogui calls this to launch Sumatra for magazine articles in Linux<br /> :*'''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :*'''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :*'''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :*'''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> '''Content/DOS_linux_Magazines.zip''' - Linux supplement for the Media Pack - This contains Linux DOSBox configuration, launcher, and cue files related to magazines and disk magazines (bat, bsh, command, conf, cue).<br /> <br /> ====Custom Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :*'''eXo/Update/update.bat'''<br /> :*'''eXo/Update/update.sh'''<br /> :*'''eXo/Update/update_installed.sh'''<br /> :*'''Setup.sh'''<br /> <br /> ====eXo/util/converter.sh====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ====eXo/util/regenerate.sh====<br /> <br /> :The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> :<span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions. <br /> <br /> :The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file: <br /> :#Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :#Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :#Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> :All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> :Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre> <br /> <br /> :In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :#Copies the ScummVM SVN application data to Wine<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Creates shell files<br /> :# Makes shell files executable<br /> :#Prepares shell files for conversion<br /> :#Adds Linux configuration references to Linux game setups<br /> :#Adds Linux configuration references to Windows game setups<br /> :#Adds Linux configuration references to Linux game and magazine launchers<br /> :#Adds Windows configuration references to Linux game setups<br /> :#Converts syntax for the Linux shell files from Windows batch to bash<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Note on Updates===<br /> <br /> :<span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> :In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> :<span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=649 Linux Patch 2024-09-11T21:06:35Z

<p>Parricc: /* Step 3 - Installing eXoDOS */ Updated to eXoDOS 6.</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :In your file manager, double-click on the '''eXoDOS Setup.command''' file to start the setup, and then follow the on-screen instructions. If you are asked whether you want to execute the file, click yes. If you are using Nautilus or Gnome and are not given this option, right click the file and select Run as Program.<br /> :<br /> :The setup file will check for required files and warn you if any are missing. It will also check for files from the Media Pack Add-On.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers.<br /> <br /> :It is important to run the setup and not extract any files manually. Not only are the files location sensitive, but the setup makes some changes to them.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off.<br /> <br /> :Once it is complete, run exogui to dive right in.<br /> <br /> :<span style="color: green">'''Note:'''</span> The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. However, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to run the '''eXoDOS Updater''' to update the shortcut to point to the new location. The '''eXoDOS Updater''' will allow you to reconfigure all of the installation options instead of running through the entire setup process again.<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> :Running '''start-exogui''' will start the frontend.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ====Playing Without Frontend ====<br /> <br /> :After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> :Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> :For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> :<span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to Version 5.1.linux1====<br /> <br /> :Utilities:<br /> :*Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :*120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :*Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :*LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> ===Files===<br /> <br /> ====exodos5-linux-patch.zip====<br /> :'''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS. <br /> <br /> :*'''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :*'''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :*'''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :*'''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :*'''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :*'''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :*'''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :*'''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :*'''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :*'''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :*'''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :*'''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :*'''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :*'''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :*'''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ====Custom Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :*'''eXo/Update/update.bat'''<br /> :*'''eXo/Update/update.sh'''<br /> :*'''eXo/Update/update_installed.sh'''<br /> :*'''Setup.sh'''<br /> <br /> ====eXo/util/converter.sh====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ====eXo/util/regenerate.sh====<br /> <br /> :The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> :<span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions. <br /> <br /> :The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file: <br /> :#Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :#Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :#Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> :All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> :Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre> <br /> <br /> :In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :#Copies the ScummVM SVN application data to Wine<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Creates shell files<br /> :# Makes shell files executable<br /> :#Prepares shell files for conversion<br /> :#Adds Linux configuration references to Linux game setups<br /> :#Adds Linux configuration references to Windows game setups<br /> :#Adds Linux configuration references to Linux game and magazine launchers<br /> :#Adds Windows configuration references to Linux game setups<br /> :#Converts syntax for the Linux shell files from Windows batch to bash<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Note on Updates===<br /> <br /> :<span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> :In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> :<span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=648 Linux Patch 2024-09-11T20:41:42Z

<p>Parricc: eXoDOS 6 description, and installation process steps 1-2.</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :If you have also downloaded the eXoDOS Media Pack, ensure it has been downloaded the the same directory as the base eXoDOS collection. Then, download and place the "''DOS_linux_Magazines.zip''" file in the Content directory. Do not unzip this file.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing System Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instruction.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> </pre><br /> :The "''[D]ownload the latest setup''" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "''[P]roceed with installation''" and follow the on-screen instructions.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> :Do not extract these files manually. They are location sensitive.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960. <br /> <br /> :Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> :The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ====Important Note==== <br /> :*<span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :*Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> :Running '''start-exogui''' will start the frontend.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ====Playing Without Frontend ====<br /> <br /> :After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> :Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> :For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> :<span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to Version 5.1.linux1====<br /> <br /> :Utilities:<br /> :*Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :*120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :*Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :*LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> ===Files===<br /> <br /> ====exodos5-linux-patch.zip====<br /> :'''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS. <br /> <br /> :*'''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :*'''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :*'''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :*'''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :*'''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :*'''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :*'''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :*'''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :*'''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :*'''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :*'''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :*'''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :*'''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :*'''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :*'''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ====Custom Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :*'''eXo/Update/update.bat'''<br /> :*'''eXo/Update/update.sh'''<br /> :*'''eXo/Update/update_installed.sh'''<br /> :*'''Setup.sh'''<br /> <br /> ====eXo/util/converter.sh====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ====eXo/util/regenerate.sh====<br /> <br /> :The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> :<span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions. <br /> <br /> :The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file: <br /> :#Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :#Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :#Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> :All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> :Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre> <br /> <br /> :In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :#Copies the ScummVM SVN application data to Wine<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Creates shell files<br /> :# Makes shell files executable<br /> :#Prepares shell files for conversion<br /> :#Adds Linux configuration references to Linux game setups<br /> :#Adds Linux configuration references to Windows game setups<br /> :#Adds Linux configuration references to Linux game and magazine launchers<br /> :#Adds Windows configuration references to Linux game setups<br /> :#Converts syntax for the Linux shell files from Windows batch to bash<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Note on Updates===<br /> <br /> :<span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> :In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> :<span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=647 Linux Patch 2024-09-11T20:15:20Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is a complete conversion to make all features of eXoDOS work on Linux systems just as they would in Windows. An official Linux frontend, called exogui, is included as part of this conversion. Additionally, the patch is written to ensure that the collection works as expected in dual-boot environments. After the Linux patch is installed, if eXoDOS is updated or games are installed, this will be reflected in both Linux and Windows environments.<br /> <br /> As it is encouraged to seed the collection, installing the Linux patch will not alter any torrent files. The patch does not change the existing eXoDOS framework, but instead supplements it.<br /> <br /> At this time of this writing, the latest eXoDOS Linux Patch is for version 6.4.<br /> <br /> <br /> Supported distributions include:<br /> *Arch / Manjaro Linux / SteamOS<br /> *Fedora<br /> *Ubuntu (and Ubuntu-based distributions) / Debian<br /> *Nearly any x86_64 distro that has flatpak support<br /> Unsupported:<br /> <br /> *ARM, IBM Power, and RISC-V computers and devices are '''not''' supported at this time. This includes the Raspberry Pi. We need someone to volunteer to build ARM versions of the flatpaks for support to be added.<br /> * macOS and BSD are also unsupported at this time. Until we have a volunteer to add macOS support to the frontend, this is unlikely to change. Backend support exists for the eXoDREAMM project, and the backend for eXoDOS has been partially converted in case we get a volunteer.<br /> <br /> ===Installation Process===<br /> <br /> ==== Step 1 - Extracting Zip Archive====<br /> <br /> :First, the '''eXoDOS 6.4 Linux Patch.zip''' file must be extracted to the correct location.<br /> :Copy the '''eXoDOS 6.4 Linux Patch.zip''' file to the root directory of your freshly downloaded eXoDOS 6.4 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located)<br /> :Then, in your file manager, right click on the '''eXoDOS 6.4 Linux Patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> :Alternatively, you may open the zip with a utility such as Ark, and drag the files and folders into the root eXoDOS directory.<br /> :The important thing is to ensure the files are extracted into the root directory of the collection, and not into a newly created subdirectory.<br /> :After this has been done, proceed to the next step.<br /> <br /> ====Step 2 - Installing Dependencies==== <br /> <br /> :The next step is to install the software needed to run the collection. The '''install_dependencies.command''' script will run you through a guided setup to do this.<blockquote><span style="color: green">'''Note:'''</span> If you are using Thunar or XFCE, you will first need to enable running shell files as executables. To do this, open a terminal and run the following command: <code>xfconf-query --channel thunar --property /misc-exec-shell-scripts-by-default --create --type bool --set true</code></blockquote>In your file manager, double-click on '''install_dependencies.command''' to start the dependency installer. If you are asked whether you want to execute the file, click yes.<br /> :If you are using Nautilus or Gnome and are not given this option to run by double-clicking, right click the file and select Run as Program.<blockquote><span style="color: green">'''Note:'''</span> This step will need to be done on any Linux computer that has not previously ran eXoDOS 6, even if the full setup has already been completed on a portable drive. Also note that the flatpaks are installed at a user level. As such, other users will need to run the dependency installer separately as well. If you update your video drivers, you may also need to follow that up with a flatpak update. Rerunning a dependency installer installation will handle that for you.</blockquote>Upon running the dependency installer, you will be prompted with a guided setup that gives the following options: <br />The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version. To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instructions.<br /> <pre><br /> [P]roceed with installation<br /> [D]ownload the latest setup<br /> [R]emove all installed eXo packages<br /> [A]bort installation<br /> <br /> The "[D]ownload the latest setup" option will only grab the newest version of the eXo Dependency Installer, not eXoDOS itself. This may be useful if there is a problem with the dependency installer or if new flatpaks are needed. If the dependency installer is updated, it should be reran to launch the new version.<br /> <br /> To proceed with installing the dependencies, choose "[P]roceed with installation" and follow the on-screen instructions.<br /> </pre><br /> : <br /> <br /> :*<br /> <br /> :Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> :If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord. <br /> <br /> :When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> :<u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> :<u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> :To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> :This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> :Do not extract these files manually. They are location sensitive.<br /> <br /> :The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> :You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960. <br /> <br /> :Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> :The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ====Important Note==== <br /> :*<span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :*Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> ===Using eXoDOS===<br /> <br /> ====exogui====<br /> <br /> :A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> :Running '''start-exogui''' will start the frontend.<br /> <br /> :The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ====Playing Without Frontend ====<br /> <br /> :After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> :Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> :For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> :<span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> :The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> :Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> :If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ====Creating Desktop Shortcuts==== <br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> ===Changelog===<br /> <br /> ====Changes to Version 5.1.linux1====<br /> <br /> :Utilities:<br /> :*Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :*120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :*Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :*LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> ===Files===<br /> <br /> ====exodos5-linux-patch.zip====<br /> :'''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> :This builds upon the existing file and directory structure of eXoDOS. <br /> <br /> :*'''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :*'''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :*'''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :*'''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :*'''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :*'''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ====util_linux.zip==== <br /> :'''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :*'''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :*'''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :*'''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :*'''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :*'''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :*'''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :*'''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :*'''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :*'''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :*'''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :*'''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :*'''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ====Custom Scripts====<br /> :<span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :*'''eXo/Update/update.bat'''<br /> :*'''eXo/Update/update.sh'''<br /> :*'''eXo/Update/update_installed.sh'''<br /> :*'''Setup.sh'''<br /> <br /> ====eXo/util/converter.sh====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> :To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> :Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre> <br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function=====<br /> <br /> :The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> :As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> :<span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ====eXo/util/regenerate.sh====<br /> <br /> :The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> :<span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions. <br /> <br /> :The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file: <br /> :#Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :#Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :#Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> :All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> :Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre> <br /> <br /> :In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :#Copies the ScummVM SVN application data to Wine<br /> :#Fixes zip archive references<br /> :#Fixes batch file reference inconsistencies<br /> :#Creates shell files<br /> :# Makes shell files executable<br /> :#Prepares shell files for conversion<br /> :#Adds Linux configuration references to Linux game setups<br /> :#Adds Linux configuration references to Windows game setups<br /> :#Adds Linux configuration references to Linux game and magazine launchers<br /> :#Adds Windows configuration references to Linux game setups<br /> :#Converts syntax for the Linux shell files from Windows batch to bash<br /> :#Fixes '''dosbox.conf''' typos with known solutions<br /> :#Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :#Creates DOSBox configuration files for Linux<br /> :#Makes necessary changes to Linux configuration files<br /> :#Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> ===Note on Updates===<br /> <br /> :<span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> :In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> :<span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> ===Preparing For Manual Conversion===<br /> <br /> #to do<br /> <br /> ===Packaging Files For Release===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=617 Linux Patch 2021-11-12T22:29:02Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Using eXoDOS ===<br /> <br /> ==== exogui ====<br /> <br /> : A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> : Running '''start-exogui''' will start the frontend.<br /> <br /> : The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ==== Playing Without Frontend ====<br /> <br /> : After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> : Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> : For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> : <span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> : The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> : Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> : If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ==== Creating Desktop Shortcuts ====<br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> : <span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions.<br /> <br /> : The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file:<br /> :# Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :# Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :# Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> : All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> : Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre><br /> <br /> : In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :# Copies the ScummVM SVN application data to Wine<br /> :# Fixes zip archive references<br /> :# Fixes batch file reference inconsistencies<br /> :# Creates shell files<br /> :# Makes shell files executable<br /> :# Prepares shell files for conversion<br /> :# Adds Linux configuration references to Linux game setups<br /> :# Adds Linux configuration references to Windows game setups<br /> :# Adds Linux configuration references to Linux game and magazine launchers<br /> :# Adds Windows configuration references to Linux game setups<br /> :# Converts syntax for the Linux shell files from Windows batch to bash<br /> :# Fixes '''dosbox.conf''' typos with known solutions<br /> :# Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :# Creates DOSBox configuration files for Linux<br /> :# Makes necessary changes to Linux configuration files<br /> :# Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> === Note on Updates ===<br /> <br /> : <span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> : In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the '''Content/!DOSmetadata_linux.zip''' and '''Content/Magazines_linux.zip''' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> : <span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> === Preparing For Manual Conversion ===<br /> <br /> #to do<br /> <br /> === Packaging Files For Release ===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=573 Linux Patch 2021-11-12T13:06:18Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Using eXoDOS ===<br /> <br /> ==== exogui ====<br /> <br /> : A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> : Running '''start-exogui''' will start the frontend.<br /> <br /> : The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ==== Playing Without Frontend ====<br /> <br /> : After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> : Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> : For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> : <span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> : The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> : Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> : If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ==== Creating Desktop Shortcuts ====<br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> : <span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions.<br /> <br /> : The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file:<br /> :# Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :# Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :# Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> : All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> : Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre><br /> <br /> : In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :# Copies the ScummVM SVN application data to Wine<br /> :# Fixes zip archive references<br /> :# Fixes batch file reference inconsistencies<br /> :# Creates shell files<br /> :# Makes shell files executable<br /> :# Prepares shell files for conversion<br /> :# Adds Linux configuration references to Linux game setups<br /> :# Adds Linux configuration references to Windows game setups<br /> :# Adds Linux configuration references to Linux game and magazine launchers<br /> :# Adds Windows configuration references to Linux game setups<br /> :# Converts syntax for the Linux shell files from Windows batch to bash<br /> :# Fixes '''dosbox.conf''' typos with known solutions<br /> :# Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :# Creates DOSBox configuration files for Linux<br /> :# Makes necessary changes to Linux configuration files<br /> :# Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.<br /> <br /> === Note on Updates ===<br /> <br /> : <span style="color: red">'''IMPORTANT:'''</span> If preparing a full copy of the eXoDOS Linux patch, any existing eXoDOS update files should be considered before packaging the files for final release. The initial eXoDOS 5 Linux patch included the eXoDOS 5.1 update. For completeness as well as the convenience of anyone installing the Linux patch without an active Internet connection, any new versions of '''exodos5-linux-patch.zip''' should always include the latest updates. At the same time, a cumulative update patch file, '''update_linux.zip''', is also maintained for people that would like to simply update their already installed version of eXoDOS 5. The details of how the update works will be discussed later. However, it should be noted that both the '''exodos5-linux-patch.zip''' file as well as '''update_linux.zip''' should contain the latest versions of everything at their time of release.<br /> <br /> : In the '''exodos5-linux-patch.zip''' file, any cumulative updates for bat, conf, and sh files are merged into the 'Content/!DOSmetadata_linux.zip' and 'Content/Magazines_linux.zip' files, overwriting the ones from the eXoDOS 5.0 release. Updates to game archives, on the other hand, are included in the '''eXo/util/update_linux.zip''' file.<br /> <br /> : <span style="color: red">'''CAUTION:'''</span> The '''update_linux.zip''' file hosted online is for cumulative updates and is different than the '''eXo/util/update_linux.zip''' file contained in the full release of the Linux patch. Any references in this document to the two files can be differentiated by the presence or absence of '''eXo/util/'''.<br /> <br /> === Preparing For Manual Conversion ===<br /> <br /> #to do<br /> <br /> === Packaging Files For Release ===<br /> <br /> #to do along with numerous other sections</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=572 Linux Patch 2021-11-12T10:21:20Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Using eXoDOS ===<br /> <br /> ==== exogui ====<br /> <br /> : A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> : Running '''start-exogui''' will start the frontend.<br /> <br /> : The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ==== Playing Without a Frontend ====<br /> <br /> : After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> : Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> : For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> : <span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> : The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> : Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> : If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ==== Creating Desktop Shortcuts ====<br /> <br /> : If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> : <span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions.<br /> <br /> : The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file:<br /> :# Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :# Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :# Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> : All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> : Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre><br /> <br /> : In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :# Copies the ScummVM SVN application data to Wine<br /> :# Fixes zip archive references<br /> :# Fixes batch file reference inconsistencies<br /> :# Creates shell files<br /> :# Makes shell files executable<br /> :# Prepares shell files for conversion<br /> :# Adds Linux configuration references to Linux game setups<br /> :# Adds Linux configuration references to Windows game setups<br /> :# Adds Linux configuration references to Linux game and magazine launchers<br /> :# Adds Windows configuration references to Linux game setups<br /> :# Converts syntax for the Linux shell files from Windows batch to bash<br /> :# Fixes '''dosbox.conf''' typos with known solutions<br /> :# Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :# Creates DOSBox configuration files for Linux<br /> :# Makes necessary changes to Linux configuration files<br /> :# Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=571 Linux Patch 2021-11-12T10:18:32Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Using eXoDOS ===<br /> <br /> ==== exogui ====<br /> <br /> : A member of our Discord, jelcynek, has currently created a Linux frontend, exogui, which is a fork of Flashpoint Launcher. It is still very much a work in progress, but it has been bundled with eXoDOS. As the frontend improves, newer versions will be included with updates.<br /> : Running '''start-exogui''' will start the frontend.<br /> <br /> : The website for exogui can be found at https://github.com/margorski/exodos-launcher/. At this time, jelcynek is looking for volunteers to help in the development of the frontend. If you are interested, please reach out to him in the #linux_port_for_nerds channel of our Discord.<br /> <br /> ==== Playing Without a Frontend ====<br /> <br /> : After downloading the collection, installing the dependencies with '''install_linux_dependencies.sh''', and running '''Setup.sh''', you can play the games in the following way without a frontend:<br /> : Navigate to the '''eXo/eXoDOS/!dos/''' directory. Here, you will find 7200 game directories that contain launcher and setup shell files. These files should be executed from a terminal window.<br /> <br /> : For example, from the root directory of the collection, you could type:<br /> <pre><br /> cd eXo/eXoDOS/\!dos/mi2/<br /> bash Monkey\ Island\ 2\ -\ LeChuck\'s\ Revenge\ \(1991\).sh<br /> </pre><br /> <br /> : <span style="color: green">'''Note:'''</span> if you have bash completion enabled, you can press the tab key to make typing name of a script easier.<br /> <br /> : The first time you attempt to run a game it will ask if you want to install it. Subsequent runs will directly launch the game.<br /> <br /> : Initial install may take some time depending on the size (a few of these games are upwards of 8 CDs!). During install you will be prompted to choose whether or not to enforce aspect ratio, full screen or windowed mode, and if you would like to apply a scaler. Scalers can smooth pixels, making older pixelated games look a bit more modern. The default setting is normal2x.<br /> <br /> : If you run the install file a second time, it will ask if you would like to uninstall the game. Choosing "yes" will erase the installed files from your disk, but keep the original ZIP file. You will lose any saved games, high scores, or other settings you have defined since the game was installed. If you choose not to uninstall the game you will get the chance to choose full screen or windowed again and another opportunity to change the scaler. If the scaler refuses to change, you will have to rerun the Setup file in order to extract clean copies of each games conf file.<br /> <br /> ==== Creating Desktop Shortcuts ====<br /> <br /> If you would like to create a desktop shortcut to a game, open a plain text editor, such as gedit or kate, and create a file with the .desktop extension and the following contents, making changes as appropriate:<br /> <br /> <pre><br /> [Desktop Entry]<br /> Exec=x-terminal-emulator -e "/home/username/eXoDOS/eXo/eXoDOS/\\!dos/mi1/Secret\\ of\\ Monkey\\ Island\\,\\ The\\ \\(1990\\).sh"<br /> Icon=/usr/share/icons/monkeyisland_icon.png<br /> Name[EN_US]=Secret of Monkey Island<br /> Name=Secret of Monkey Island<br /> Type=Application<br /> </pre><br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> : <span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions.<br /> <br /> : The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file:<br /> :# Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :# Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :# Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> : All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> : Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre><br /> <br /> : In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :# Copies the ScummVM SVN application data to Wine<br /> :# Fixes zip archive references<br /> :# Fixes batch file reference inconsistencies<br /> :# Creates shell files<br /> :# Makes shell files executable<br /> :# Prepares shell files for conversion<br /> :# Adds Linux configuration references to Linux game setups<br /> :# Adds Linux configuration references to Windows game setups<br /> :# Adds Linux configuration references to Linux game and magazine launchers<br /> :# Adds Windows configuration references to Linux game setups<br /> :# Converts syntax for the Linux shell files from Windows batch to bash<br /> :# Fixes '''dosbox.conf''' typos with known solutions<br /> :# Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :# Creates DOSBox configuration files for Linux<br /> :# Makes necessary changes to Linux configuration files<br /> :# Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=462 Linux Patch 2021-11-11T13:05:11Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.<br /> <br /> : <span style="color: green">'''Note:'''</span> '''Setup_with_regeneration.sh''' does not handle the flatpak/native check in the '''update.sh''' or '''update.bat''' file. The '''util_linux.zip''' file is different from '''util.zip''' in many ways. This script does not focus on the contents of those files, even if was used to prepare them originally. If '''regenerate.sh''' or '''converter.sh''' have been updated, please ensure that you have also updated the '''util_linux.zip''' file with the newer versions.<br /> <br /> : The '''regenerate.sh''' script first checks that the eXoDOS files are in the correct location in relation to it. Next, it loads the <span style="color: blue">convertScript</span> function into memory, copies the '''Setup.bat''' file to '''Setup_with_regeneration.sh''', and converts the newly created file to bash. From here, the script makes several changes to the '''Setup_with_regeneration.sh''' file:<br /> :# Any file reference case inconsistencies are fixed, all '''util.zip''' references are changed to '''util_linux.zip''', and additionally needed unzip directives are added.<br /> :# Checks are added to the beginning of the script to ensure it is located in the root directory of the eXoDOS collection.<br /> :# Additional code is added to the end of the script to generate Linux versions for all config files and Windows batch files.<br /> <br /> : All text manipulation for the above steps is done through sed commands. The final step will scare many people away as it involves numerous sed commands within a sed command. This means each line has a great deal of escape sequences.<br /> <br /> : Here is a code snippet to give an idea of what some of this looks like:<br /> <pre><br /> sed -i -e '$a\<br /> \<br /> clear\<br /> echo "The rest of the setup is automated but could take over an hour."\<br /> echo ""\<br /> cd "$initialDir"\<br /> cd eXo\<br /> echo "Copying scummvm svn application data to Wine."\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "md %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM" 2>/dev/null\<br /> [ -e "util/scummvm.ini" ] \&\& wine cmd /c "copy .\\\util\\\scummvm.ini %USERPROFILE%\\\AppData\\\Roaming\\\ScummVM\\\scummvm.ini" 2>/dev/null\<br /> \<br /> echo "Fixing zip archive references."\<br /> \<br /> echo "Fixing batch file reference inconsistencies. This may take several minutes."\<br /> [ `ls -1 Update/*.bat 2>/dev/null | wc -w` -gt 0 ] && sed -i -e "s/^goto :eof/goto :end/" Update/*.bat 2>/dev/null\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> sed -i -e "s/\\.\\\\\\download\\\\\\/.\\\\\\DOWNLOAD\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exodos\\\\\\/eXoDOS\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\/eXo\\\\\\/Ig" "$file"\<br /> sed -i -e "s/exo\\\\\\update/eXo\\\\\\Update/Ig" "$file"\<br /> sed -i -e "s/PPMode/PPmode/I" "$file"\<br /> sed -i -e "s/c\\*\\.rom/C*.ROM/I" "$file"\<br /> sed -i -e "s/\\.rom/.ROM/I" "$file"\<br /> sed -i -e "s|mt32\\\\\\soundcanvas\\.sf2|mt32\\\\\\SoundCanvas.sf2|I" "$file"\<br /> sed -i -e "s/update\\.zip/update_linux.zip/Ig" "$file"\<br /> sed -i -e "s/ver\\.exo/ver_linux.exo/Ig" "$file"\<br /> sed -i -e "s/ver\\.txt/ver_linux.txt/Ig" "$file"\<br /> sed -i -e "/findstr \\/C/ s/\\"%GameName/\\":%GameName/" "$file"\<br /> sed -i -e "/fullindex=/ s/\\"\\$gamename/\\":\\$gamename/" "$file"\<br /> done\<br /> echo "Creating game shell files."\<br /> echo "Preparing files for conversion..."\<br /> for file in eXoDOS/\\\!*/*/*.bat eXoDOS/\\\!*/*/*/*.bat Update/*.bat Magazines/*.bat\<br /> do\<br /> cp "$file" "${file%.bat}.sh"\<br /> done\<br /> chmod +x eXoDOS/\\\!*/*/*.sh\<br /> chmod +x eXoDOS/\\\!*/*/*/*.sh\<br /> chmod +x Update/*.sh\<br /> chmod +x Magazines/*.sh\<br /> \<br /> echo "Creating Linux configuration references. Please wait."\<br /> for file in eXoDOS/\\!*/*/install.sh\<br /> do\<br /> sed -i -e "s/^\\(.*\\)\\.bat\\(.*\\)/&\\n\\1.sh\\2/" "$file"\<br /> done\<br /> </pre><br /> <br /> : In short, when the '''Setup_with_regeneration.sh''' script is executed, the code added to the bottom does the following:<br /> :# Copies the ScummVM SVN application data to Wine<br /> :# Fixes zip archive references<br /> :# Fixes batch file reference inconsistencies<br /> :# Creates shell files<br /> :# Makes shell files executable<br /> :# Prepares shell files for conversion<br /> :# Adds Linux configuration references to Linux game setups<br /> :# Adds Linux configuration references to Windows game setups<br /> :# Adds Linux configuration references to Linux game and magazine launchers<br /> :# Adds Windows configuration references to Linux game setups<br /> :# Converts syntax for the Linux shell files from Windows batch to bash<br /> :# Fixes '''dosbox.conf''' typos with known solutions<br /> :# Fixes '''dosbox.conf''' file and directory reference inconsistencies<br /> :# Creates DOSBox configuration files for Linux<br /> :# Makes necessary changes to Linux configuration files<br /> :# Applies game specific fixes to Linux files<br /> <br /> : <span style="color: green">'''Note:'''</span> All of the inconsistency fixes and game specific changes are manually added to the '''regenerate.sh''' script. There is no magic voodoo code to determine what needs to be changed to make each game work correctly.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=386 Linux Patch 2021-11-08T17:49:05Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== eXo/util/converter.sh ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== eXo/util/regenerate.sh ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=385 Linux Patch 2021-11-08T17:44:49Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> : <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== '''eXo/util/converter.sh''' ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> : Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script it creates. Details about those scripts will be described later in this document.<br /> <br /> ===== convertScript Function =====<br /> <br /> : The <span style="color: blue">convertScript</span> function runs a series of sed and Perl commands to convert a file from batch to bash. <span style="color: red">'''As this is a very complex text manipulation process, the order of each command is critically important.'''</span> It is heavily recommended to add any new commands at the bottom of the function. Each subsequent text manipulation command may search for and change something that was previously altered. If any existing text manipulation commands are changed, everything needs to be very carefully audited. Edge cases are everywhere.<br /> <br /> : Example code snippet from the <span style="color: blue">convertScript</span> function:<br /> <pre><br /> #escape backslashes in all echoes, change \ to / after the redirects<br /> sed -i -e '/^echo.*\\/{<br /> s|#|##|g;<br /> s|\\|/#|g;<br /> :a;<br /> s|^\(echo.*>.*\)/#\(.*\)|\1/\2|;<br /> ta;<br /> s|/#|\\\\|g;<br /> s|##|#|g;<br /> }' "$currentScript"<br /> <br /> #escape quotes on echoes without redirects<br /> sed -i -e "/^echo/{ />/! s/\"/\\\\\"/g }" "$currentScript"<br /> <br /> #add a double quote to the beginning of echoes<br /> sed -i -e "s/^echo /echo \"/" "$currentScript"<br /> <br /> #add a double quote to the end of echoes without redirects<br /> sed -i -e "/^echo/{ />/!s/.$/\"/ }" "$currentScript"<br /> <br /> #ensure echo redirects are preceded by spaces<br /> sed -i -e "/^echo/ {/[^[:space:]]>>/ s/>>/ >>/;}" "$currentScript"<br /> sed -i -e "/^echo.*[^[:space:]]>/{ />>/! s/>/ >/;}" "$currentScript" <br /> <br /> #add a double quote to the end of echoes with redirects<br /> sed -i -e "/^echo/ s/ >>/\" >> /" "$currentScript"<br /> sed -i -e "/^echo.*>/{ />>/! s/ >/\" > /;}" "$currentScript"<br /> <br /> #escape all $ characters<br /> sed -i -e "s/\\$/\\\\$/g" "$currentScript"<br /> <br /> #make all occurrences of goto lowercase except on echo and comment lines<br /> sed -i -e '/^echo\|^#/!s/goto/goto/gI' "$currentScript"<br /> <br /> #change all occurrences of GOTO to goto only after echo redirections<br /> sed -i -e '/^echo.*>.*GOTO/ {<br /> s/#/##/g;<br /> s/GOTO/goto#/g;<br /> :a;<br /> s/^\(echo.*>.*\)goto#\(.*\)/\1goto\2/;<br /> ta;<br /> s/goto#/GOTO/g;<br /> s/##/#/g;<br /> }' "$currentScript"<br /> </pre><br /> <br /> : As shown in the above code snippet, comments are used to tell what every text manipulation operation does. This is necessary to ensure that the script continues to be maintainable.<br /> <br /> : <span style="color: green">'''Note:'''</span> When doing a systematic conversion of the eXoDOS collection, it is important to remember that the <span style="color: blue">convertScript</span> function is ran against every batch file in eXoDOS, with the exception of those in game archives (e.g. '''run.bat'''). Additional game specific text manipulations are written in the '''regenerate.sh''' script.<br /> <br /> ==== '''eXo/util/regenerate.sh''' ====<br /> <br /> : The purpose of the '''regenerate.sh''' script is to assist in the development of future Linux patches by automating the conversion of config files and Windows batch files to Linux compatible bash files. It creates a '''Setup_with_regeneration.sh''' file in the root directory of the eXoDOS collection. By executing the '''Setup_with_regeneration.sh''' script, a converted eXoDOS setup will run followed by conversion operations to prepare the rest of the collection for the creation of a Linux patch. This script is not intended for end-users. As new versions of eXoDOS come out, both the '''regenerate.sh''' script as well as the '''converter.sh''' will need to be altered. It is impossible to predict how the Windows batch files will be written. It is very common for eXo to do some extremely complex operations in batch files that can make updating these scripts very challenging.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=384 Linux Patch 2021-11-08T16:02:42Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> ==== exodos5-linux-patch.zip ====<br /> : '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> : This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> :* '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> :* '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> :* '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> :* '''exogui''' - This directory contains the files needed to run exogui.<br /> :* '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> :* '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> :* '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> ==== util_linux.zip ====<br /> : '''util_linux.zip''' Contents:<br /> :* '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> :* '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> :* '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> :* '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> :* '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> :* '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> :* '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> :* '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> :* '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> :* '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> :* '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> :* '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> :* '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> ==== Custom Scripts ====<br /> <span style="color: green">'''Note:'''</span> For the rest of this document, files will be described using their locations after installing eXoDOS.<br /> <br /> : The following files are not simply handled by the conversion script, but have custom modifications:<br /> :* '''eXo/Update/update.bat'''<br /> :* '''eXo/Update/update.sh'''<br /> :* '''eXo/Update/update_installed.sh'''<br /> :* '''Setup.sh'''<br /> <br /> ==== '''eXo/util/converter.sh''' ====<br /> : The '''converter.sh''' script contains the <span style="color: blue">convertScript</span> function, which, when called, will attempt to convert a file's batch code to bash. The file that the <span style="color: blue">convertScript</span> function is ran against is determined by a variable, <span style="color: blue">$currentScript</span>. Note that the '''converter.sh''' script is not meant to be executed directly.<br /> <br /> : To prevent direct execution, the '''converter.sh''' script checks that a variable, <span style="color: blue">$hideMessage</span>, has a value of <span style="color: blue">true</span>. Note that even when <span style="color: blue">$hideMessage</span> = <span style="color: blue">true</span>, executing '''converter.sh''' does not automatically call the <span style="color: blue">convertScript</span> function. Instead, the <span style="color: blue">source</span> command should be ran against '''converter.sh''' to bring the <span style="color: blue">convertScript</span> function into the shell session's memory. Then, assuming the value of <span style="color: blue">$currentScript</span> has been set, the <span style="color: blue">convertScript</span> function should be called.<br /> <br /> : Example use where bat files in a directory called '''filesToConvert''':<br /> <pre><br /> hideMessage='true'<br /> . eXo/util/converter.sh<br /> for file in filesToConvert/*.bat<br /> do<br /> cp "$file" "${file%.bat}.sh"<br /> done<br /> chmod +x filesToConvert/*.sh<br /> for currentScript in filesToConvert/*.sh<br /> do<br /> convertScript<br /> done<br /> </pre><br /> <br /> Normally, the '''converter.sh''' script is called by the '''regenerate.sh''' script and the '''Setup_with_regeneration.sh''' script that creates. Details about that script will be described later in this document.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=383 Linux Patch 2021-11-08T12:27:07Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Changelog ===<br /> <br /> ==== Changes to Version 5.1.linux1 ====<br /> <br /> : Utilities:<br /> :* Removed All-Seeing Eye 3 from Linux menu option (map tracking inaccurate)<br /> <br /> : Games:<br /> :* 120 Degree Below Zero (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> :* Eye of the Beholder III - Assault on Myth Drannor (1993) - Replaced patched AESOP.EXE file with original (patched exe does not run properly in Linux)<br /> :* LockerGnome Quest Redux (2012) - Changed launcher to use ScummVM (sciAudio.exe not an option for Linux)<br /> <br /> === Files ===<br /> <br /> '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> * '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> * '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> * '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> * '''exogui''' - This directory contains the files needed to run exogui.<br /> * '''install_linux_dependencies.sh''' - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> * '''Setup.sh''' - This guided setup script installs the eXoDOS collection for Linux.<br /> * '''start-exodus''' - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> '''util_linux.zip''' Contents:<br /> * '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> * '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> * '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> * '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> * '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> * '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> * '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> * '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> * '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> * '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.<br /> <br /> The following files are not simply handled by the conversion script, but have custom modifications:<br /> * '''eXo/Update/update.bat'''<br /> * '''eXo/Update/update.sh'''<br /> * '''eXo/Update/update_installed.sh'''<br /> * '''Setup.sh'''</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=354 Linux Patch 2021-11-07T12:58:27Z

<p>Parricc: </p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well as add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> At this time of this writing, the latest release of the eXoDOS Linux Patch is compatible with eXoDOS 5.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 - Extracting Zip Archive ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 - Installing Dependencies ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 - Installing eXoDOS ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Files ===<br /> <br /> '''exodos5-linux-patch.zip''' contains the following files and directories:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre><br /> <br /> This builds upon the existing file and directory structure of eXoDOS.<br /> <br /> * '''Content/!DOSmetadata_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for games; Note these files are also updated to have the content for Version 5.1.linux1.<br /> * '''Content/Magazines_linux.zip''' - This contains DOSBox configuration files as well as the launcher and setup files (conf, sh, bat) for disk magazines.<br /> * '''eXo/util/util_linux.zip''' - This contains utilities needed to run eXoDOS. <span style="color: red">'''Note that several internal files are different than the ones in util.zip, despite having the same filenames.<span style="color: red">'''<br /> * '''exogui''' - This directory contains the files needed to run exogui.<br /> * '''install_linux_dependencies.sh - This guided setup script installs the Linux dependencies needed for eXoDOS.<br /> * '''Setup.sh - This guided setup script installs the eXoDOS collection for Linux.<br /> * '''start-exodus - This launches the Linux eXoDOS frontend, exogui.<br /> <br /> '''util_linux.zip''' Contents:<br /> * '''aria.zip''' - Same as in eXoDOS 5 Lite torrent.<br /> * '''ASE3.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''ASE.zip''' - Same file as in eXoDOS 5.1 update.<br /> * '''BRC32.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''CHOICE.EXE''' - Same as in eXoDOS 5 torrent.<br /> * '''converter.sh''' - Script to assist in the development of the Linux patch; converts batch files to bash shell scripts for Linux.<br /> * '''deprotect.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''dos2unix.exe''' - Added to eXoDOS Linux patch to ensure configuration changes in Windows do not add carriage returns.<br /> * '''dosbox.zip''' - Modified for eXoDOS Linux patch to include Linux conf files.<br /> * '''GBC.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''LinuxPackages.zip''' - Contains Linux DOSBox packages needed for eXoDOS.<br /> * '''mt32.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''regenerate.sh''' - Development tool that attempts to convert Windows eXoDOS '''Setup.bat''' file into a Linux shell script, which upon being executed will run through the installation and then systematically convert all files to work with Linux.<br /> * '''scummvm.ini''' - Same as in eXoDOS 5 torrent.<br /> * '''scummvm.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''SetConsole.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''SHADERS.zip''' - Same as in eXoDOS 5 torrent.<br /> * '''ssr.exe''' - Same as in eXoDOS 5 torrent.<br /> * '''Ultimapper5.zip''' - Same as in eXoDOS 5.1 update.<br /> * '''update_linux.zip''' - Linux branch update files; Linux bash files added and Windows batch files modified; changelog.txt and ver_linux.txt are used to track Linux branch; 5.1 game patch zips also included; Note the EOB3 executable (AESOP.EXE) was reverted to the 5.0 version for Linux compatibility.</div>

Parricc https://wiki.retro-exo.com/index.php?title=Linux_Patch&diff=353 Linux Patch 2021-11-07T09:56:59Z

<p>Parricc: Linux Patch</p> <hr /> <div>== eXoDOS Linux Patch ==<br /> <br /> === Overview ===<br /> <br /> The eXoDOS Linux patch is an attempt to make all features of eXoDOS work on Linux systems just as they would in Windows. As a Linux alternative to LaunchBox, a game launcher called exogui is bundled with the patch. Additionally, the patch is written to ensure that the collection works as expected in dualboot environments. After the Linux patch is installed, if eXoDOS is updated, games are installed, or game options are modified, the changes will be reflected in both Linux and Windows environments.<br /> <br /> Installing the Linux patch will replace existing Windows batch files with modified versions as well add additional Linux specific files. It also switches eXoDOS to the Linux update branch. Our team must test and merge any new upstream eXoDOS patches into the Linux branch before they will become available. In addition, there may be updates released for the Linux branch without a corresponding one in the main branch.<br /> <br /> Having said that, installing the Linux patch or any updates will not affect any files in the torrent. You will continue to be able to seed the collection.<br /> <br /> === Installation Process ===<br /> <br /> ==== Step 1 ====<br /> <br /> : First, the '''exodos5-linux-patch.zip''' file must be extracted to the correct location.<br /> <br /> : Copy the '''exodos5-linux-patch.zip''' file to the root directory of your freshly downloaded eXoDOS 5 collection. (This is where files such as '''eXoDOS Catalog.pdf''' and '''Setup.bat''' are located) <br /> : Then, in your file manager, right click on the '''exodos5-linux-patch.zip''' file and select "''Extract Here''" or "''Extract'' > ''Extract archive here''", depending on what you are using.<br /> <br /> : Alternatively, you may open a terminal in that directory, and run the following command:<br /> : <pre>unzip -o exodos5-linux-patch.zip</pre><br /> <br /> : After this has been done, installing the collection still requires two more steps, which can be done either in exogui or from a terminal. If you do these steps in exogui, you will need to close and restart it after the installation has been completed.<br /> <br /> ==== Step 2 ====<br /> <br /> : The next step is to install the software needed to run the collection.<br /> <br /> : If you want to do this through exogui, double-click on '''start-exogui'''. (If exogui fails to start, consult the troubleshooting section of the readme)<br /> : Then, select "''Install dependencies''" in the exogui home tab. Alternatively, you may run this same setup by executing '''install_linux_dependencies.sh''' from a terminal window.<br /> <br /> : Note that this step will need to be done on any computers that have not previously ran eXoDOS 5, even if the full setup has been ran on a portable drive.<br /> <br /> : The '''install_linux_dependencies.sh''' script will run a guided setup to install the needed software.<br /> <br /> : Officially supported distributions include:<br /> :* Debian<br /> :* Fedora<br /> :* Ubuntu (and Ubuntu-based distributions)<br /> :* Arch / Manjaro Linux.<br /> <br /> : Updates will be periodically released to ensure that compatibility is maintained as newer distributions come out. Simply choose the update menu option to grab the newest version of the setup.<br /> : If you would like to request support for your distro to be added, feel free to reach out in the #linux_port_for_nerds channel of our Discord.<br /> <br /> : When running this setup, you will be given an option to choose between flatpaks and native DOSBox packages. There are some advantages and disadvantages of each.<br /> <br /> : <u>Flatpaks</u>: Flatpaks have an advantage over native DOSBox packages in that they are more portable. If you are using an unsupported distribution, they will make it much easier to get the collection working. However, our tests have shown that some computers (not most) have distorted FluidSynth output in ECE when using flatpaks.<br /> <br /> : <u>Native Packages</u>: Native packages do not have this issue, but must be regularly maintained and updated as newer distributions come out. Upgrading your version of Linux may break a previously installed native package. We will occasionally release updates to ensure compatibility is maintained.<br /> <br /> ==== Step 3 ====<br /> <br /> : The final step is to run the eXoDOS Setup.<br /> <br /> : To do this through exogui, select "''eXoDOS Setup''" on the home tab. Alternatively, you may run '''Setup.sh''' from a terminal window.<br /> <br /> : This will unpack the required eXoDOS files, including the LaunchBox assets and the games front end assets/configs to run the collection. In addition, it will extract the Linux game launcher and setup files. It will make the collection work on both Windows and Linux computers and ensure updates work correctly for both operating systems.<br /> <br /> : Do not extract these files manually. They are location sensitive.<br /> <br /> : The eXoDOS Setup will give you the opportunity to customize your set. This includes the option to remove Adult games from the exogui and LaunchBox menu. This removes games with sex or nudity from the LaunchBox XML file. This does not remove violent games. Please make use of the ratings category in LaunchBox if you would like to filter the games further.<br /> <br /> : You will also be prompted as to if you would like your global defaults to be Fullscreen or Windowed and whether or not you would like to default to Aspect Ratio On or Off. If you choose windowed mode, you will have the option between 640x480 or 1280x960.<br /> <br /> : Once it is complete, you may either launch the game shell files directly or run exogui to dive right in.<br /> <br /> : The eXoDOS collection can be run from any directory, as all launch files are designed to use relative paths to each other. Note, however, if you choose to add a desktop shortcut to exogui and then later move eXoDOS to a new location, you will need to rerun the setup to update the shortcut. Note that the setup gives an option to reconfigure previous installations of eXoDOS rather than running through the entire setup process over again.<br /> <br /> ==== Important Note ====<br /> :* <span style="color: red">'''DO NOT RUN'''</span> the main Windows '''Setup.bat''' file after installing the Linux patch. It will undo the changes necessary for Linux compatibility.<br /> :* Running the '''Setup.sh''' installation on an eXoDOS instance that was previously installed in Windows will clear the Windows installed games playlist in LaunchBox (due to LaunchBox being reinstalled).<br /> <br /> === Files ===<br /> <br /> '''exodos5-linux-patch.zip''' contains the following files:<br /> <pre><br /> ├── Content<br /> │ ├── !DOSmetadata_linux.zip<br /> │ └── Magazines_linux.zip<br /> ├── eXo<br /> │ └── util<br /> │ └── util_linux.zip<br /> ├── eXoDOS Linux ReadMe.txt<br /> ├── exogui<br /> │ └── [exogui files]<br /> ├── install_linux_dependencies.sh<br /> ├── Setup.sh<br /> └── start-exogui<br /> </pre></div>

Parricc