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: scripts/README.md
+17-5
Original file line number
Diff line number
Diff line change
@@ -10,24 +10,36 @@ Five steps are needed to get these scripts working. Those steps are numbered and
10
10
11
11
## Prerequisites
12
12
13
-
**1. Install utility "aunpack"**
13
+
**1. Install utilities**
14
14
15
-
If you want to use the auto-install feature, you will need to have installed the utility "aunpack", which is part of [atool](https://www.nongnu.org/atool/). Technically this is an optional step but it unlocks a huge part of the convenience of using these scripts, so I would always recommend doing this.
15
+
Technically each of these utilities used by the "quakelaunch" script are optional, but at least the first two of these are involved in implementing fundamental features of the script and are therefore highly recommended.
16
+
17
+
If you want to use the auto-install feature -- which unlocks a huge part of the convenience of using these scripts -- you will need to have installed the utility "aunpack", which is part of [atool](https://www.nongnu.org/atool/).
16
18
17
19
In my case I installed that utility and its dependencies with:
18
20
```bash
19
21
sudo apt-get install atool
20
22
```
21
-
You may then want/need to install some of the various tools mentioned at the bottom of the atool webpage. For example, I already had tar, zip, gzip, and p7zip... but I needed to install rar as well in order to handle .rar archives.
23
+
(You may then also want/need to install some of the various tools mentioned at the bottom of the atool webpage. For example, I already had tar, zip, gzip, and p7zip on my system... but I needed to install rar as well in order to handle .rar archives.)
24
+
25
+
Next, if you want the script to generate notifications when errors happen, the "notify-send" utility needs to be present. In some cases your system may already include this utility by default; if not, you can find a package to install that will include it. For example on Pop!\_OS 22.04 LTS I needed to do this:
26
+
```bash
27
+
sudo apt-get install libnotify-bin
28
+
```
29
+
That package should also be appropriate for other Ubuntu-like systems.
30
+
31
+
Finally, you may want to install a utility for playing a sound when a notification is generated. By default the "paplay" utility will be used. However, you can change that in your configuration file (as described below) if you don't have or wish to install "paplay", or if you just want to use some other sound player.
22
32
23
33
**2. Install Python module "expak" (optional)**
24
34
25
-
The main script can also optionally use my Python module [expak](https://github.com/neogeographica/expak) to look inside pak files and make better decisions about things like what map to launch and whether a gamedir is "standalone" (has its own progs.dat). To use this module, you will need Python 2 or Python 3 installed; the script will use whatever executable has the name "python". The expak module will need to be installed for that version of Python with:
35
+
The main script can also optionally use my Python module [expak](https://github.com/neogeographica/expak) to look inside pak files and make better decisions about things like what map to launch and whether a gamedir is "standalone" (has its own progs.dat). To use this module, you will need Python 2 or Python 3 installed; the script will use whatever executable has the name "python". (In the case of Pop!\_OS 22.04 LTS, which only has "python3", I needed to install the "python-is-python3" package in order to have a "python" executable available.)
36
+
37
+
The expak module will need to be installed for that version of Python using the Python package manager "pip", e.g.:
26
38
```bash
27
39
sudo pip install expak
28
40
```
29
41
30
-
If you can't or don't want to install these things globally, there are various ways to tackle that, but I think that's outside the scope of this doc.
42
+
If you can't or don't want to install this module globally, there are various ways to tackle that, but I think that -- and any other instruction about installing or using "pip" -- is outside the scope of this doc.
0 commit comments