Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
systems:openlara [2023/09/12 11:46] – created openlara system modhacksystems:openlara [2023/10/28 04:34] (current) – rephrase requirements atari
Line 1: Line 1:
-====== Tomb Raider (OpenLara) ====== +<WRAP group> 
 +<WRAP round box twothirds column> 
 +{{ https://raw.githubusercontent.com/fabricecaruso/es-theme-carbon/master/art/logos/openlara.svg?nolink&340 }}
  
-This game engine recreation seeks to allow you to play the original **Tomb Raider** engine games, from 1 all the way up to 5. +====== Tomb Raider (OpenLara======
-**Tomb Raider 1** is officially supported and fully playable unlike episodes 2 and 3 (but you can still play them by launching manually maps)+
-More info on [[https://docs.libretro.com/library/openlara/|Libretro]]. +
-<WRAP important 60%> +
-OpenLara requires Batocera version 38 or a version available from the beta channel. +
-</WRAP>+
  
 +Added in Batocera **v38**, this game engine recreation seeks to allow you to play the original **Tomb Raider** engine games, from 1 all the way up to 5. [[https://batocera.org/compatibility.php|It is currently x86_64 only.]]
  
-===== Installation ===== +**Tomb Raider 1** is officially supported and fully playable. Episodes 2 and 3 require workarounds to launch, more info on [[https://docs.libretro.com/library/openlara/|Libretro's documentation]].
-==== Get Tomb Raider Original files ====+
  
 +<WRAP center round todo>
 +Add that info to this page.
 +</WRAP>
  
-To get **OpenLara** to work, you'll need to retrieve a few files from the official version of Tomb Raider. You can use the PC versions, [[https://www.gog.com/en/game/tomb_raider_123|[GOG]]], [[https://store.steampowered.com/app/224960/Tomb_Raider_I/|[STEAM]]]PSX or SATURN.+This system scrapes metadata for the "pc" group and loads the ''openlara'' set from the currently selected themeif available.
  
 +Grouped with the "ports" group of systems.
 +</WRAP>
  
-<WRAP info 60%+<WRAP third column
-The PSX version is clearly recommended because it has better video quality (less compressed than the PC DOS version) and more audio tracks. You can use the tool [[https://github.com/m35/jpsxdec|jpsxdec]] to dump the files.+{{ https://raw.githubusercontent.com/fabricecaruso/es-theme-carbon/master/art/consoles/openlara.png?nolink&350 |}} 
 +</WRAP>
 </WRAP> </WRAP>
  
 +==== Quick reference ====
  
 +  * **Emulator:** [[#retroarch|RetroArch]]
 +  * **Core:** [[#libretro:_openlara|libretro: OpenLara]]
 +  * **Folder:** ''/userdata/roms/openlara''
 +  * **Accepted ROM formats:** ''.croft''
  
-=== Files required ===+===== Installation ===== 
 + 
 +==== Getting the original Tomb Raider files ==== 
 + 
 +OpenLara requires the original files from either the PC version ([[https://www.gog.com/en/game/tomb_raider_123|GOG]] or [[https://store.steampowered.com/app/224960/Tomb_Raider_I/|Steam]]), PlayStation or Sega Saturn releases of the game. These include the ''DATA'' (levels and loading screen), ''FMV'' (videos) and ''AUDIO'' files. 
 + 
 +<WRAP tip> 
 +The PSX version is clearly recommended because it has better video quality and more audio tracks.  
 +</WRAP> 
 + 
 +=== PlayStation ===
  
 +The files from the PS version can be dumped using [[https://github.com/m35/jpsxdec|jpsxdec]].
  
-You will need the files located in the **DATA** folders (levels and loading screen)**FMV** (videos), and the **AUDIO** tracks. If you choose the GOG or Steam version, follow the method from the paragraph [[Rip from GOG or Steam version]] to retrieve the necessary files.+(FIXME are the files required identical to the PC version? If notit should be mentioned here)
  
-==== Rip from GOG or Steam version ====+=== PC version (GOG or Steam===
  
-=== Retrieve files from Tomb Raider 1 image (Steam/GOG version)===+== Tomb Raider 1 ==
  
 When you get Tomb Raider from **GOG** or **STEAM**, you will see the following files inside the folder: ''GAME.GOG'', ''GAME.DAT'', ''dosbox.exe'' and the dosbox configuration file. The file **game.dat** is actually the **iso** of the game that contains the necessary files, for that we will use a command under DOSBOX to mount the image and copy the necessary files. When you get Tomb Raider from **GOG** or **STEAM**, you will see the following files inside the folder: ''GAME.GOG'', ''GAME.DAT'', ''dosbox.exe'' and the dosbox configuration file. The file **game.dat** is actually the **iso** of the game that contains the necessary files, for that we will use a command under DOSBOX to mount the image and copy the necessary files.
Line 48: Line 67:
 You just need to retrieve the necessary files from these folders and paste them into the **OpenLara** structure. You just need to retrieve the necessary files from these folders and paste them into the **OpenLara** structure.
  
 +<WRAP center round todo>
 +Provide a method that doesn't require dosbox.
 +</WRAP>
  
 ==== Converting MP3 files to .ogg files ==== ==== Converting MP3 files to .ogg files ====
  
-You need to convert the audio files in the main **TombRaider** folder to the ''.ogg'' format. You can do this with the following small **FFmpeg** script.+The audio files as-is will not work with OpenLara, they must be converted to the OGG format. You can do this with **ffmpeg** script.
  
-<code>bash+<code>
 for f in ./*.mp3; do ffmpeg -i "$f" -c:a libvorbis -q:a 4 "${f/%mp3/ogg}"; done for f in ./*.mp3; do ffmpeg -i "$f" -c:a libvorbis -q:a 4 "${f/%mp3/ogg}"; done
 </code> </code>
  
- +<WRAP center round todo
-<WRAP tip 60%+Examples for other platforms, instructions to do this from within Batocera.
-Note that you can use the audio files from the console version with the data files of the PC version.+
 </WRAP> </WRAP>
  
 +==== Installing the files ====
  
- +Navigate to ''/userdata/roms/openlara''.
-==== Organize your files ==== +
- +
- +
-In ''/userdata/roms/openlara/'' we will prepare the folder structure:+
  
 Start by creating a folder of your choice to hold the file structure (example **TombRaider**). Start by creating a folder of your choice to hold the file structure (example **TombRaider**).
Line 80: Line 98:
   * To have the background of the game title screen, it is necessary to retrieve the RAW files from the console version and paste them into a **DELDATA** folder at the same level as the level/video/audio folders.   * To have the background of the game title screen, it is necessary to retrieve the RAW files from the console version and paste them into a **DELDATA** folder at the same level as the level/video/audio folders.
  
 +{{:emulators:openlara-folders.png|}}
  
-{{:emulators:openlara-folders.png?400|}} +==== Prepare the game for EmulationStation ====
- +
- +
-==== Prepare the game from EmulationStation ==== +
  
 EmulationStation supports the **.croft** extension, which serves as a launcher for the level. Start by creating a text file ''TombRaider1.croft'' and edit it to add the path of the level to launch: EmulationStation supports the **.croft** extension, which serves as a launcher for the level. Start by creating a text file ''TombRaider1.croft'' and edit it to add the path of the level to launch:
Line 90: Line 106:
 <code>TombRaider/level/1/GYM.PSX</code> <code>TombRaider/level/1/GYM.PSX</code>
  
- +<WRAP info>
-<WRAP info 60%>+
 In this example, the "GYM" level will be launched first. You can then press the **Select** button to display the menu and return to the TombRaider title screen. In this example, the "GYM" level will be launched first. You can then press the **Select** button to display the menu and return to the TombRaider title screen.
 </WRAP> </WRAP>
  
-----+===== Emulators =====
  
-==== FPS mode ====+==== RetroArch ====
  
-With OpenLara, you can experience Tomb Raider like you've never played before. You can try it through the eyes of Lara Croft with the primary person camera, for this you can switch to this mode by pressing L1 + A and exit this mode with the same combination. FPS also available in 2-Player Mode.+RetroArch has [[emulators:retroarch|its own page]].
  
-==== 2-Player Mode ====+=== libretro: openlara === 
 + 
 +== libretro: openlara configuration == 
 + 
 +Standardized features for this core: ''openlara.autosave'' 
 + 
 +^ ES setting name ''batocera.conf_key'' ^ Description => ES option ''key_value''
 +^ Settings that apply to all systems this core supports || 
 +| **RENDERING RESOLUTION ''global.lara-resolution''** | Enhancement. Increase the rendering resolution. Makes 3D objects clearer.\\ => 320x240 ''320x240'', 360x480 ''360x480'', 480x272 ''480x272'', 512x384 ''512x384'', 512x512 ''512x512'', 640x224 ''640x224'', 640x448 ''640x448'', 720x576 ''720x576'', 800x600 ''800x600'', 960x720 ''960x720'', 1024x768 ''1024x768'', 1280x720 ''1280x720'', 1280x960 ''1280x960'', 1600x1200 ''1600x1200'', 1920x1080 ''1920x1080'', 1920x1440 ''1920x1440'', 1920x1600 ''1920x1600'', 2048x2048 ''2048x2048'', 2560x1440 ''2560x1440'', 3840x2160 ''3840x2160'', 7680x4320 ''7680x4320'', 15360x8640 ''15360x8640'', 16000x9000 ''16000x9000''. | 
 +| **FRAMERATE ''global.lara-framerate''** | Set desired framerate.\\ => 30fps ''30fps'', 60fps (Default) ''60fps'', 70fps ''70fps'', 72fps ''72fps'', 75fps ''75fps'', 90fps ''90fps'', 100fps ''100fps'', 119fps ''119fps'', 120fps ''120fps'', 144fps ''144fps'', 240fps ''240fps'', 244fps ''244fps''. | 
 + 
 +===== Controls ===== 
 + 
 +With OpenLara, you can experience Tomb Raider like you've never played before. You can try it through the eyes of Lara Croft with the primary person camera, for this you can switch to this mode by pressing L1 + A and exit this mode with the same combination. 
 + 
 +<WRAP center round info>
 You can include your friend with whom you want to pass TR levels together. Press Start from Second Controller in order to go 2-Payer Mode. You can include your friend with whom you want to pass TR levels together. Press Start from Second Controller in order to go 2-Payer Mode.
 +</WRAP>
 +
 +===== Troubleshooting =====
 +
 +==== Further troubleshooting ====
 +
 +For further troubleshooting, refer to the [[:support|generic support pages]].
 +
 +
  • systems/openlara.1694519195.txt.gz
  • Last modified: 3 years ago
  • by modhack