Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucamug/functional-pacman
https://github.com/lucamug/functional-pacman
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lucamug/functional-pacman
- Owner: lucamug
- Created: 2024-11-24T08:39:54.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-28T22:48:44.000Z (14 days ago)
- Last Synced: 2024-12-28T23:23:25.130Z (14 days ago)
- Language: Elm
- Homepage: https://lucamug.github.io/functional-pacman/
- Size: 814 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - lucamug/functional-pacman - (Elm)
README
# Functional Pac-Man
An interpretation of the [Pac-Man](https://en.wikipedia.org/wiki/Pac-Man) game, written in approximately [1K lines](https://github.com/lucamug/functional-pacman/blob/main/src/Game.elm) of purely functional code. It runs both in the browser and in the terminal.
The game is written in the [Elm language](https://elm-lang.org/) and the [Gren language](https://gren-lang.org/), using the [TUI library](https://packages.gren-lang.org/package/blaix/gren-tui/version/3.0.2/overview) for the version that runs in the terminal.
## To run the game in the browser
Go to: [https://lucamug.github.io/functional-pacman/](https://lucamug.github.io/functional-pacman/)
## To run the game in the terminal
Execute:
```shell
git clone https://github.com/lucamug/functional-pacman/
cd functional-pacman
node docs/gren-pacman
```
The program requires Node.js v20 or later.
## Debug modality
By pressing [B], you can display additional internal information on the side of the playing area.
## Development
Clone the repository:
```shell
git clone https://github.com/lucamug/functional-pacman/
cd functional-pacman
npm install
```
Several commands are available in the `cmd` folder.
### To work on the Elm code
```shell
cmd/start-elm
```
Then point your browser to [http://localhost:8003/](http://localhost:8003/).
The main file is [Game.elm](https://github.com/lucamug/functional-pacman/blob/main/src/Game.elm). This code is the same as Game.gren. They are kept in sync via a symlink. After editing any Elm file, the game in the browser will automatically hot-reload.
### To work on the Gren code
```shell
cmd/start-gren
```
This will compile and run the code in the terminal. [ESC] or [CTRL + C] to exit.
To format the Gren code
```shell
cmd/format-gren
```
### To release a new version
Run
```shell
cmd/build
```
This will update the file in `/docs/`. These files can be published via Github from "Settings > Pages > Deploy from a branch > main /docs".