README.md

   1 # 液体「ekitai」
   2
   3 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.
   4
   5 ## Usage
   6 ekitai reads a text file with the desired simulation. samples can be found in the samples/ directory of this repo. valid characters for the simulation are as follows
   7 - `#`: wall block
   8 - `~`: water
   9 - `@`: pump, spawns water below it
  10 - `O`: drain, removes water around it
  11
  12 ## Installation
  13 ### Deb based
  14 ### Arch based
  15 ### Build from Source
  16 as this project does not use stack or cabal or anything, haskell dependencies will have to be installed separately. this is a bit difficult to document since the packages varies by distro, for arch at least, the following are required
  17 - ghc
  18 - ghc-libs
  19 - haskell-vector
  20 - haskell-brick
  21
  22 and then simply run `sudo make install`.
  23
  24 ## FAQ
  25 **why ekitai?**
  26
  27 ekitai is fluid in japanese. since naming your projects in a different language is apparently cool.
  28
  29 **why not in c?**
  30
  31 c would have probably been one of the best choices to do this project in, but i wanted to add a bit of challenge by using a language that i didn't know.
  32