You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Quake Injector
2
-
Quake Injector is a tool to *download, install and play* Quake (some call it "Quake 1") singleplayer maps from Spirit's "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.
2
+
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.
3
3
4
4

5
5
@@ -11,17 +11,20 @@ Quake Injector is a tool to *download, install and play* Quake (some call it "Qu
11
11
- Cross-Platform
12
12
-[Free, Open Source Software](https://github.com/hrehfeld/QuakeInjector/), released under the GPL.
13
13
- Scan your Quake directory for already installed maps
14
-
15
14
16
15
## Installation
17
-
Quake Injector requires Quake and Java.
16
+
On Windows you can use a self-contained executable. On Linux and MacOS you need Java.
18
17
19
-
1. Make sure you have the [latest Java version](https://adoptopenjdk.net/) installed
20
-
1. Download the latest [Quake Injector release](https://github.com/hrehfeld/QuakeInjector/releases)
18
+
### Windows
19
+
1. Download the latest ["QuakeInjector.exe" release](https://github.com/hrehfeld/QuakeInjector/releases)
21
20
1. Extract the .zip file
22
-
1. Double click `quakeinjector.jar`, or simply start it with `java -jar quakeinjector.jar` from the extraction directory. On Windows, you can also use the supplied `quakeinjector.bat`.
21
+
1. Double click the QuakeInjector.exe
23
22
24
-
Do **not** launch it directly from your browser, your settings would be eaten by a [friendly horde of Shoggies](http://www.macguff.fr/goomi/unspeakable/vault299.html), and the settings are vital to the program.
23
+
### Linux and MacOS
24
+
1. Make sure you have a recent Java installed
25
+
1. Download the latest [Quake Injector release](https://github.com/hrehfeld/QuakeInjector/releases)
26
+
1. Extract the .zip file
27
+
1. Double click `lib/quakeinjector.jar`, or start it with `java -jar lib/quakeinjector.jar`. On Windows, you can also use the supplied `quakeinjector.bat`.
25
28
26
29
*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).
27
30
@@ -36,11 +39,11 @@ This works well in combination with a filter. For example you could look at all
36
39
## Known Problems
37
40
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.
38
41
39
-
1. 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](http://neogeographica.com/site/pages/guides/engines.html#04) is recommended.
42
+
1. 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](https://neogeographica.com/site/pages/guides/engines.html#04) is recommended.
40
43
41
44
## Development
42
45
### Bugs and feedback
43
-
If anything that feels weird occurs to you, or you find a definite bug, please [report it as an issue](https://github.com/hrehfeld/QuakeInjector/issues). Likewise, give us a shout if you want to help with development. Pull requests are welcome!
46
+
If anything that feels weird occurs to you, or you find a definite bug, please [report it as an issue](https://github.com/hrehfeld/QuakeInjector/issues). Likewise, give us a shout if you want to help with development. Pull requests are what powers the project!
44
47
45
48
### Running from source
46
49
To run the application for development, run the following command in the root directory.
@@ -78,6 +81,9 @@ On Unix:
78
81
./gradlew winDist
79
82
```
80
83
84
+
### Notes
85
+
- Use `git tag` to define the name of the resulting JAR: `git tag alpha05` will make gradlew compile `QuakeInjector-alpha05.jar`.
0 commit comments