Skip to content

Home

Jump to bottom
Dan Wilkins edited this page Feb 1, 2024 · 8 revisions

The LanternExtractor is a command line program meaning that it has no user interface. The following is a guide for how to use it on various platforms. You can either compile the source yourself or you can download the latest binaries on the releases page.

Editing the settings file

Included in the same directory as your extractor binary is a settings.txt file. The file contains various options to customize the output from the extractor. You must ensure that the directory path is correctly set and points to a valid EverQuest Trilogy folder. You can also set the desired output format. For more info on these formats, check the FAQ.

Running the program

The program is run with a single argument. This can be one of the following:

  • A specific archive (e.g. gfaydark.s3d) - Extracts only the specified archive.
  • A zone shortname (e.g. qeynos) - Extracts the zone, objects and characters associated with that zone.

The extractor also supports batch extraction keywords including:

  • all - Extracts all client assets, the best option if you want to build assets for the LanternEQ client.
  • zones - Extracts only zone data.
  • characters - Extracts only character data.
  • equipment - Extracts only equipment data.
  • sounds - Extracts all sounds.
  • music - Copies all .XMI files to a music folder (LanternEQ).
  • clientdata - Copies all client data to a clientdata folder (LanternEQ).

A full list of the archives and what they contain can be found here.

All files are extracted into the Exports/<ArchiveName> folder.

Windows 10

  1. Open the folder containing the LanternExtractor executable.
  2. Click on the address bar at the top of the windows, type cmd, and then press Enter. This will open up a command prompt pointed to the current directory.
  3. Type lanternextractor <args> where <args> is the name of the archive you want to extract or a batch keyword. Press Enter.

Troubleshooting

No valid EQ files found for: '<archive>' at path: <your path>

Either the archive name you have entered is not valid, or the path you have set in your settings file is incorrect.

Usage: lantern.exe <filename/shortname/all>

You have not entered correct command line arguments. Ensure you have specified a single archive name or all.

Bugs and Requests

Found an issue with the extractor that's not covered here? Want to request a feature? Create a ticket and we will see what we can do.

Clone this wiki locally