https://github.com/chemaclass/phel-snake

An implementation of the snake game using the CLI terminal written in phel.
https://github.com/chemaclass/phel-snake

functional-programming phel phel-lang php

Last synced: 3 months ago
JSON representation

An implementation of the snake game using the CLI terminal written in phel.

• Host: GitHub
• URL: https://github.com/chemaclass/phel-snake
• Owner: Chemaclass
• Created: 2022-06-09T15:52:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-22T05:52:48.000Z (7 months ago)
• Last Synced: 2024-06-22T16:43:45.112Z (7 months ago)
• Topics: functional-programming, phel, phel-lang, php
• Language: PHP
• Homepage: https://phel-lang.org/
• Size: 2.1 MB
• Stars: 14
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Phel Snake

A cli-game written in [Phel](https://phel-lang.org/).

## Two versions in one repository

This repository contains a [full-version](src/full-version/game.phel) and a [simplified version](src/simple-version/game.phel) of the snake game. 

> I thought it might be useful to create a simplified version as introduction to the fundamentals of the language and the game itself.

- In the simplified version, you will find just the snake inside the board.

- In the full version, the snake will increase the speed as it reaches to goals.

## How to play

### Instructions

Use the arrow keys to move the snake: `left-right-top-down`.

The game ends when the snake touches any border of the board.

#### In the full version

- You can use the `space-key` to accelerate a few cells the snake in the current direction.

- The snake will automatically increase the speed after each goal reached, unless you enable the "god mode" (using the argument `god-mode`).

### Setup

#### Using Docker

1. Clone this repo

2. Build the image and run the container: `docker-compose up --build -d`

3. Run the game: `docker exec -it phel_snake ./tools/composer play`

#### Locally (no Docker)

1. Ensure you have PHP `>=8.2`

   1. Some help about how to install multiple PHP versions locally on [linux](https://github.com/phpbrew/phpbrew) and [Mac](https://github.com/shivammathur/homebrew-php)

2. Clone this repo

3. Install the dependencies: `./tools/composer install`

4. Run the game: `./tools/composer play`

---

Alternatively, you can run the game using the `phel run` command

You can define some optional arguments

- width={N} -> width of the board

- height={N} -> height of the board

- god-mode -> the snake won't increment the speed as it eats apples

- debug -> you can see internal stats of the game

- simple -> start the simplified game

```bash

vendor/bin/phel run src/main.phel width=40 height=15 god-mode debug

```

## Demo

![](img/demo-snake.webp)