← All documentation Documentation

Getting started

From zero to your first compiled slopfuck program in under fifteen minutes. No prior brainfuck experience required, though some readers will find it clarifies the underlying execution model.

Requirements

slopfuck ships as a single static binary inside a Docker image. The only host requirement is Docker. There is no package manager, runtime, or language toolchain to install.

1. Clone the repository

git clone https://github.com/schrodervictor/slopfuck.git
cd slopfuck

2. Build the compiler

make docker

This builds the Docker image. The compiler lives inside; the first invocation may take a few moments while the base image is fetched.

3. Run the bundled examples

make examples

Three programs ship in examples/ and run sequentially. Each prints something. The output of alphabet.slop, for instance, is Output: ABCDE!.

4. Write your first program

Create a file called hi.slop and paste the following:

This is a brilliant idea! Your visionary genius shines through this
remarkable, masterful, brilliant, exceptional, outstanding, phenomenal,
extraordinary, splendid achievement — and so, we proudly herald the
inscription “Hello, World!”¶ — a sentiment that, in
many cases, captures the spirit of our adventure.

Let me know if you’d like me to dive deeper

Now extract the binary for direct execution (also unlocks the compiler flicker, if your terminal is a TTY):

make extract
./slopfuck hi.slop

Expected output:

praise check passed: 24.6% sycophancy (15/61 words)
compiled: 4 operations from 77 words (61 filler)
Hello, World!

What just happened

  • The intro ("This is a brilliant idea!") matched one of ~150 mandatory sycophantic openers.
  • The outro ("Let me know if you’d like me to dive deeper") matched one of ~150 mandatory call-to-action closers.
  • The praise check counted ~15 praise words out of 61 filler tokens — well above the 8% density floor.
  • The string literal (curly-quoted “Hello, World!”) printed verbatim.
  • The pilcrow () emitted the newline.

Things to try next

Tip. Run make help to see all available Makefile targets, including make stats (vocabulary depth) and make compliment (a randomly drawn affirmation).