Skip to content

Commit

Permalink
Work on README
Browse files Browse the repository at this point in the history
  • Loading branch information
zmnpl committed Apr 18, 2021
1 parent 6d0f957 commit ddeceee
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# twad - terminal wad launcher

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

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 until you decide to rip and tear. Simple as that.
## Start **classic DOOM** with a **classic terminal user interface**

Needless to say, that this mostly was designed for *nix systems. However, with WSL this might as well be usable in Windows somewhen in the future. Though quite some testing needs to go into this.
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 stuff and cross compiled for Windows. Actually it works quite well. So...

## Now with experimental **Windows support**

**Watch Out**: This tool is still in early state and might contain bugs.

Expand All @@ -23,7 +27,7 @@ Needless to say, that this mostly was designed for *nix systems. However, with W
* Collect stats from savegames
* Run games from rofi or dmenu
* Separate savegame / demo folders for games (in **~/.config/twad/...***)
* Responsive layout
* Responsive layout (kind of)

# Installation Options

Expand All @@ -41,6 +45,11 @@ I'll to add precompiled binaries to the [releases page](https://github.com/zmnpl
go get -u github.com/zmnpl/twad
```

## d) Windows

* Download the .exe from the [releases page](https://github.com/zmnpl/twad/releases)
* Doubleclick

# Setup your environment

***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**.
Expand All @@ -65,7 +74,7 @@ An example could look like this:
└── doom.wad
```
1) Setup your **DOOMWADDIR** as described above
2) twad's first start will ask you for the path of **DOOMWADDIR**
2) twad's first start will ask you to configure your **DOOMWADDIR** in the options
3) Within twad create games
4) Add mods to your games
666) __Rip and Tear__
Expand Down Expand Up @@ -117,15 +126,19 @@ twad --dmenu
- ~~Demo recording / viewing~~
- ~~More statistics; Parse from savegames~~
- ~~Zip-Import~~
- WSL support
- ~~WSL support~~ Windows support
- idgames download + autoinstall
- wad archive download + autoinstall
- All the TODO flags
- Error Handling
- Metadata scraping(?)
- Tagging / Searching / Filtering

# Credit where credit is due

## All the other Doom launchers
There are already great alternatives to manage and launch your WADs out there for many years and I give credits to all of them since I've taken a lot of inspiration and knowledge on their functionality. Especially [Doomlauncher](https://github.com/nstlaurent/DoomLauncher) is a cool piece of software and the source code is well structured and good to read which helped me quite a lot.

## Doom logo

The use of the DOOM ASCII logo has been nicely permitted by Frans P. de Vries. Find it's history [here](http://www.gamers.org/~fpv/doomlogo.html)
Expand Down

0 comments on commit ddeceee

Please sign in to comment.