Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 4.41 KB

README.md

File metadata and controls

90 lines (70 loc) · 4.41 KB
Raw

Quake Injector

Quake Injector is a tool to download, install and play Quake (some call it "Quake 1") singleplayer maps from the "Quaddicted archive":https://www.quaddicted.com - basically the complete history of all quake singleplayer maps ever made. Ever been annoyed by an excruciating installation process? Could not figure out how to install a certain map? Well, this tool makes it a piece of cake. Simply pick a map and click Install.

Screenshot of the Quake Injector

Features

Installation

On Windows you can use a self-contained executable. On Linux and MacOS you need Java.

Windows

  1. Download the latest "QuakeInjector.exe" release
  2. Extract the .zip file
  3. Double click the QuakeInjector.exe

Linux and MacOS

  1. Make sure you have a recent Java installed
  2. Download the latest Quake Injector release
  3. Extract the .zip file
  4. Double click lib/quakeinjector.jar, or start it with java -jar lib/quakeinjector.jar. On Windows, you can also use the supplied quakeinjector.bat.

Keep in mind this software is still in heavy development. The alpha tag hints at it not being feature complete, and possibly buggy. See the included licence (COPYING) for more details on warranties, etc. (there are none).

Basic Manual

Filtering, Sorting and the Package Table

Right above the table of available packages you see a filter field. Here you can specify a filter for the listing. Let's say you want to see only maps from 2001? Enter "2001" without the quotes. Or for all maps by Vondur, enter "Vondur". You can also enter multiple words, they will be connect by a logical AND. So "czg 2000" would show you all maps czg made in 2000. To reset the filter simply delete all text from it.

At the top of the package list there are the table headers (duh!). Click on them to sort the table.

This works well in combination with a filter. For example you could look at all maps from 2008 sorted by rating.

Known Problems

  1. On Linux/MacOS and other case-sensitive operating systems you won’t have much joy as there is no engine that can ignore the case of filenames yet. There will be one and it will be a good one, but for now you're pretty much on your own, as a lot of maps were packed with mixed case filenames by the original authors.

  2. Also be aware that most engines cannot run some of the latest and greatest maps, because those maps break the original quake engine limits. A modern Quake engine is recommended.

Development

Bugs and feedback

If anything that feels weird occurs to you, or you find a definite bug, please report it as an issue. Likewise, give us a shout if you want to help with development. Pull requests are what powers the project!

Running from source

To run the application for development, run the following command in the root directory.

On Windows:

gradlew.bat run

On Unix:

./gradlew run

Building

To build a jar, grab the source and run the following command in the root directory. The jar will be in the build/libs directory.

On Windows:

gradlew.bat assemble

On Unix:

./gradlew assemble

Building a Windows EXE

To build an EXE for Windows, grab the source and run the following command in the root directory. It will create a zip in the build/distributions directory.

On Windows:

gradlew.bat winDist

On Unix:

./gradlew winDist

Notes

  • Use an annotated Git tag to define the name of the resulting JAR: git tag -a "alphaXX" -m "alphaXX" will make gradlew compile QuakeInjector-alphaXX.jar.

Credits

  • Hauke 'megaman' Rehfeld (initial programming)
  • Spirit (initial concept)
  • These lovely people (updates, fixes, features, maintenance) ❤️