Skip to content

Commit 4e06006

Browse files
Clean up readme
1 parent 141271a commit 4e06006

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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.
33

44
![Screenshot of the Quake Injector](https://www.quaddicted.com/_media/quakeinjector_20091117.png "Screenshot of the Quake Injector")
55

@@ -11,17 +11,20 @@ Quake Injector is a tool to *download, install and play* Quake (some call it "Qu
1111
- Cross-Platform
1212
- [Free, Open Source Software](https://github.com/hrehfeld/QuakeInjector/), released under the GPL.
1313
- Scan your Quake directory for already installed maps
14-
1514

1615
## 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.
1817

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)
2120
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
2322

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`.
2528

2629
*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).
2730

@@ -36,11 +39,11 @@ This works well in combination with a filter. For example you could look at all
3639
## Known Problems
3740
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.
3841

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.
4043

4144
## Development
4245
### 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!
4447

4548
### Running from source
4649
To run the application for development, run the following command in the root directory.
@@ -78,6 +81,9 @@ On Unix:
7881
./gradlew winDist
7982
```
8083

84+
### Notes
85+
- Use `git tag` to define the name of the resulting JAR: `git tag alpha05` will make gradlew compile `QuakeInjector-alpha05.jar`.
86+
8187
## Credits
8288
- Hauke 'megaman' Rehfeld (initial programming)
8389
- Spirit (initial concept)

0 commit comments

Comments
 (0)