Skip to content

Commit 58f73d1

Browse files
committed
Adjust readme and setup text
1 parent 5fd5525 commit 58f73d1

File tree

4 files changed

+27
-17
lines changed

4 files changed

+27
-17
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,41 @@
22

33
![demo](demo.gif)
44

5-
If you love __DOOM__ and you love your terminal, then twad might be for you. It is a terminal based WAD manager and launcher for ZDoom engine games. At it's core twad lets you set up a multitude of WAD file combinations, store them and launch them with the press of a button.
5+
If you love __DOOM__ and rather not leave your terminal like me, then you might be one of the few that might like **twad**. It is a terminal based WAD manager and launcher for ZDoom engine games. At it's core twad lets you set up a multitude of WAD file combinations, store them and launch them with the press of a button.
66

77
There are already great alternatives to manage and launch your WADs out there for many years and twad will probably never be as sophisticated. Though I figured: there are not so many for the terminal. Twad let's you stay in the terminal and on your keyboard as long as possible. Simple as that.
88

9-
__ALPHA__
10-
This tool is still in very early state.
9+
As a little bonus, twad collects some statistics for you (of course doesn't send them anywhere!) and organizes savegames for each mod combination in a separate folder.
10+
11+
## Watch Out
12+
13+
This tool is still in very early state and might contain bugs.
1114

1215
## Installation
1316

1417
### AUR
1518

16-
An AUR package is planned.
19+
https://aur.archlinux.org/packages/twad-git
1720

18-
### Manual
21+
### Manually
1922

2023
```golang
2124
go get -u github.com/zmnpl/twad
2225
```
2326

24-
## Usage
27+
### Binary Download
28+
29+
I'll to add precompiled binaries to the [releases page](https://github.com/zmnpl/twad/releases). It comes without dependencies, just download and run it.
30+
31+
## Initial Config
32+
33+
1) Create a base directory which holds gets to hold all your DOOM files
34+
2) Put your **doom.wad** and **doom2.wad** in that base dir
35+
3) Drop all your mods in here (Subdirectories are of course possible)
36+
4) Within twad create games
37+
5) Add mods to your games
38+
666) __Rip and Tear__
2539

26-
1) Set up your base directory
27-
2) Create games
28-
3) Add mods to your games
29-
4) __Rip and Tear__
3040

3141
## Rofi Mode
3242

main

28.3 KB
Binary file not shown.

tui/settingsPage.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ import (
1616
const (
1717
setupOkHint = "Hit [red]Ctrl+O[white] when you are done."
1818

19-
setupPathExplain = `For [orange]twad[white] to function correctly, you should have all your DOOM mod files organized in one central directory. Subdirectories per mod are possible of course.
19+
setupPathExplain = `For [orange]twad[white] to function correctly, you should have all your DOOM mod files organized in one central directory. Put your doom.wad and doom2.wad in that central directory and create subdirectories per mod for the respective files.
2020
Navigate with arrow keys or Vim bindings. [red]Enter[white] or [red]Space[white] expand the directory. Highlight the righ one and hit [red]Ctrl+O[white]`
2121

22-
setupPathExample = `[red]->[white]/home/slayer/games/DOOMmods [red]# i need this folder
23-
[white]/home/slayer/games/DOOMmods[orange]/BrutalDoom [grey]# sub dir for Brutal Doom
24-
[white]/home/slayer/games/DOOMmods[orange]/QCDE [grey]# sub dir for QCDE`
22+
setupPathExample = `[red]->[white]/home/slayer/games/DOOMmods [red]# put doom.wad and doom2.wad in here
23+
[white]/home/slayer/games/DOOMmods[orange]/BrutalDoom [grey]# sub dir for Brutal Doom
24+
[white]/home/slayer/games/DOOMmods[orange]/QCDE [grey]# sub dir for QCDE`
2525
)
2626

2727
// settings page
@@ -32,7 +32,7 @@ func makeSettingsPage() *tview.Flex {
3232
pathSelector := makePathSelectionTree(basePathPreview)
3333

3434
explanation := tview.NewTextView().SetRegions(true).SetWrap(true).SetWordWrap(true).SetDynamicColors(true)
35-
fmt.Fprintf(explanation, "%s\n\nExample:\n", setupPathExplain)
35+
fmt.Fprintf(explanation, "%s\n\nPoint me to the highlighted directory:\n", setupPathExplain)
3636
fmt.Fprintf(explanation, "%s", setupPathExample)
3737
fmt.Fprintf(explanation, "\n\n%s", setupOkHint)
3838

@@ -43,10 +43,10 @@ func makeSettingsPage() *tview.Flex {
4343
settingsFlex.SetTitleColor(accentColor)
4444

4545
settingsPage := tview.NewFlex().SetDirection(tview.FlexColumn).
46-
AddItem(settingsFlex, 78, 0, true).
46+
AddItem(settingsFlex, 90, 0, true).
4747
AddItem(tview.NewBox().SetBorder(false), 0, 1, false)
4848

49-
settingsFlex.AddItem(explanation, 11, 0, false).
49+
settingsFlex.AddItem(explanation, 12, 0, false).
5050
AddItem(basePathPreview, 1, 0, false).
5151
AddItem(pathSelector, 0, 1, true)
5252

twad

-4.54 MB
Binary file not shown.

0 commit comments

Comments
 (0)