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
+37-21
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# twad - terminal wad launcher
2
2
3
-
If you love __DOOM__ and love your terminal like me, then you might like this. **twad** is a terminal based WAD manager and launcher for doom source ports. At it's core twad lets you set up a multitude of WAD file combinations, store them and launch them with a couple of key strokes. It is light weight and blazing fast to use.
3
+
If you love __DOOM__ and love your terminal then **twad** is for you. **twad** is a terminal based WAD manager and launcher for doom source ports. At it's core twad lets you set up a multitude of WAD file combinations, store them and launch them with a couple of key strokes. It is light weight and fast to use.
4
4
5
5
## Start **classic DOOM** with a **classic terminal user interface**
6
6
7
-
Twad let's you stay in the terminal and on your keyboard as long as possible until you decide to **rip and tear**. Simple as that.
8
-
9
-
Needless to say that this mostly was designed for *nix systems. However, meanwhile I've added some OS-sensitive stuff and cross compiled for Windows. Actually it works quite well. So...
7
+
Twad let's you stay in the terminal and on your keyboard as long as possible until you decide to **rip and tear**. Simple as that. Needless to say that this mostly was designed for *nix systems. However, meanwhile I've added some OS-sensitive behaviour and cross compiled for Windows. Actually it works quite well. So...
10
8
11
9
## Now with experimental **Windows support**
12
10
13
11
**Watch Out**: This tool is still in early state and might contain bugs.
14
12
15
-

13
+

14
+
15
+

16
16
17
17
# Features
18
18
@@ -26,6 +26,7 @@ Needless to say that this mostly was designed for *nix systems. However, meanwhi
26
26
* Collect some stats from the cames console output as well as playtime and so on (not sending it anywhere)
27
27
* Collect stats from savegames
28
28
* Run games from rofi or dmenu
29
+
* Import .zip files containing mods
29
30
* Separate savegame / demo folders for games (in **~/.config/twad/...***)
30
31
* Responsive layout (kind of)
31
32
@@ -54,7 +55,13 @@ go get -u github.com/zmnpl/twad
54
55
55
56
***twad*** assumes, you have **one folder**, where your IWADs are located. All your pwads (mapsets, gameplay mods, ...) need to be in the same or subfolder of this. The folder, where you put your IWADs is known to source ports as **DOOMWADDIR**.
56
57
57
-
An example could look like this:
58
+
1) Setup your **DOOMWADDIR** as described above
59
+
2) twad's first start will ask you to configure your **DOOMWADDIR** in the options
60
+
3) Within twad create games
61
+
4) Add mods to your games
62
+
666)__Rip and Tear__
63
+
64
+
## An example could look like this
58
65
```bash
59
66
~/DOOM ❯❯❯ tree
60
67
.
@@ -73,30 +80,39 @@ An example could look like this:
73
80
├── doom2.wad
74
81
└── doom.wad
75
82
```
76
-
1) Setup your **DOOMWADDIR** as described above
77
-
2) twad's first start will ask you to configure your **DOOMWADDIR** in the options
78
-
3) Within twad create games
79
-
4) Add mods to your games
80
-
666)__Rip and Tear__
83
+
84
+
## Or this on Windows
85
+
```cmd
86
+
C:\DOOM\> dir
87
+
.
88
+
├── Ashes 2063
89
+
│ ├── Ashes2063Maps115.wad
90
+
│ └── Ashes2063Mod115.pk3
91
+
├── Back To Saturn X e1
92
+
│ ├── btsx_e1a.wad
93
+
│ ├── btsx_e1b.wad
94
+
│ └── btsx_e1.deh
95
+
├── D4T
96
+
│ └── D4Tv2.5.pk3
97
+
├── Sigil
98
+
│ ├── SIGIL_COMPAT.wad
99
+
│ └── SIGIL.wad
100
+
├── doom2.wad
101
+
└── doom.wad
102
+
```
103
+
81
104
82
105
## More on DOOMWADDIR
83
106
84
-
Your DOOM source port needs to know about the base folder of your mods and IWADs to work properly, since ***twad*** uses relative paths. ***twad**'s default method for this is to set the ***DOOMWADDIR*** environment variable when starting a game. This is only set for the current game session. (Should you already have set DOOMWADDIR, twad will shadow it with whatever is set in its configuration)
107
+
Your DOOM source port needs to know about the base folder of your mods and IWADs to work properly, since ***twad*** uses relative paths. ***twad***'s default method for this is to set the ***DOOMWADDIR*** environment variable when starting a game. This is only set for the current game session. (Should you already have set DOOMWADDIR, twad will shadow it with whatever is set in its configuration)
85
108
86
109
An alternative/additional method is to add paths to the respective source ports config. For *zdoom* ports it could look like this:
87
110
```bash
88
111
# in your doom engine .ini
89
112
[FileSearch.Directories]
90
-
PATH=/home/doomguy/Doom# path to DOOMWADDIR
113
+
PATH=/home/doomguy/DOOM# path to DOOMWADDIR
91
114
```
92
115
93
-
There is flag in the options which lets Twad try to do this automatically for these engines if it finds the respective config:
If you are using something different, please configure it accoridingly or send in an issue or pull request ;)
99
-
100
116
# Rofi Mode
101
117
102
118
You can use [***rofi***](https://github.com/davatorium/rofi) or [***dmenu***](https://tools.suckless.org/dmenu/) to launch your games. Run twad like this to use the respective programm. This will open rofi/dmenu and show a list of all games you already have. Select one you want to play and hit enter. Of course this will also track your statistics.
@@ -107,7 +123,7 @@ twad --dmenu
107
123
```
108
124
**For instant Rip & Tear** bind this to a keyboard shortcut
0 commit comments