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 or at /usr/share/ekitai/samples. 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 you can also consult the man page with `man ekitai`.
  13
  14 ## Installation
  15 ### Deb based
  16 you can get the deb file from my site, the installation process is as follows
  17 ```
  18 wget https://files.danieliu.xyz/repos/debian/ekitai.hs/ekitai.hs_1.0-1.deb
  19 sudo dpkg -i ekitai.hs_1.0-1.deb
  20 sudo apt-get install -f
  21 ```
  22
  23 ### Arch based
  24 simply get the pkgbuild from my site
  25 ```
  26 mkdir ekitai.hs-git
  27 cd ekitai.hs-git
  28 wget https://files.danieliu.xyz/repos/arch/ekitai.hs/PKGBUILD
  29 makepkg -si
  30 ```
  31
  32 ### Build from Source
  33 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
  34 - ghc
  35 - ghc-libs
  36 - haskell-vector
  37 - haskell-brick
  38
  39 and then simply run `sudo make install`.
  40
  41 ## FAQ
  42 **why ekitai?**
  43
  44 ekitai is fluid in japanese. since naming your projects in a different language is apparently cool.
  45
  46 **why not in c?**
  47
  48 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.
  49