Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add build instructions to readme #22

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
DFHACKVER ?= 0.40.16-r1
DFHACKVER ?= 0.40.19-r1

DFVERNUM = `echo $(DFHACKVER) | sed -e s/-r.*// -e s/\\\\.//g`

Expand Down Expand Up @@ -52,4 +52,4 @@ inst_all:
cd plugins && DFHACKVER=$(DFHACKVER) DF=$(DF) DH=$(DH) PLUGIN=automaterial make inst

clean:
-rm $(OUT)
-rm $(OUT)
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,25 @@ Vitaly Pronkin aka mifki <[email protected]>

[Home Page / Sources](https://github.com/mifki/df-twbt) -- [Latest Release](https://github.com/mifki/df-twbt/releases) -- [Development Builds](http://build.mifki.com) -- [Discussion](http://www.bay12forums.com/smf/index.php?topic=138754.0) -- [Report an Issue](https://github.com/mifki/df-twbt/issues)

## Building & Installing ##

If you use an installation package or a version of TWBT bundled with DF, ignore
this section.

If you want to build DFHack and TWBT yourself, use this.

First, compile DFHack. Building TWBT requires a functioning DFHack dev environment.

1. Build TWBT with: `DFHACKVER=0.40.19-r1 DF=/your/path/to/df_linux DH=/your/path/to/dfhack make
2. Install the plugins with: `DFHACKVER=0.40.19-r1 DF=/your/path/to/df_linux DH=/your/path/to/dfhack make
3. Copy over additional files:
```
cp dist/*png $DF/data/art/
cp dist/overrides.txt $DF/data/init/
```
4. Use TWBT compatible tileset.
Included is Spacefox: edit data/init/init.txt to use Spacefox_16x16_text.png

## Text and Map Tilesets ##

Main function is to use separate fonts (tilesets) for map tiles in Fortress Mode and for text. These fonts may have different tile size, usually square for the map and non-square for text. There also no limit of minimum 80 columns anymore, so bigger tiles can be used on small screens.
Expand Down Expand Up @@ -203,4 +222,4 @@ This list comes from `df/tiletype.h` include file in DFHack source code.

> *0.40:* UnderworldGateStairD, UnderworldGateStairU, UnderworldGateStairUD,

> Void, Waterfall
> Void, Waterfall