deb pkg
[ekitaihs.git] / ekitai.1
1 .TH EKITAI 1 2021-05-02
2 .SH NAME
3 ekitai \- terminal fluid simulation written in haskell
4 .SH SYNOPSIS
5 .B ekitai
6 [ekitai options] filename
7 .SH DESCRIPTION
8 ekitai.hs is a terminal fluid simulator written in haskell. it is a submission to RUHacks 2021. the simulation algorithm is quite simple, it's a similar particle based one that games like 'the sandbox' and 'terraria' use.
9 .SH OPTIONS
10 .TP
11 \fB\-t\fR <\fITIMESTEP\fP>, \fB\-\-timestep=\fR\fITIMESTEP\fR
12 Changes the physics timestep, default is 50000.
13 .SH FILES
14 ekitai reads in a file with special characters that represents simulation elements. here is a list of valid characters:
15
16 #: wall block, stationary and blocks movement
17
18 ~: water block
19
20 @: pump block, spawns water below it
21
22 O: drain block, removes water around it
23 .SH AUTHORS
24 \fBekitai\fP was written by Daniel Liu
25 .SH REPORTING BUGS
26 Please open an issue at https://github.com/MrPicklePinosaur/ekitai.hs