https://github.com/jzwood/crufty-crafts

https://github.com/jzwood/crufty-crafts

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jzwood/crufty-crafts
• Owner: jzwood
• Created: 2023-06-20T02:54:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-04T04:32:31.000Z (about 1 year ago)
• Last Synced: 2024-10-11T20:20:14.681Z (27 days ago)
• Language: Elixir
• Size: 269 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Crufty Crafts

Crufty Crafts is a meta-game where you navigate a virtual dune-buggy to avoid traps and collect more coins than your opponents. Your tools to accomplish this task include the following apis:

```

- GET /api/host/

- GET /api/game//join/

- GET /api/game//player//move/

- GET /api/game//player//info

```

The meta-game is how to use these APIs to write a bot to play Crufty Crafts.

https://crufty-crafts.gigalixirapp.com/



  



## Complete API

### Join Game

```

GET  /api/host/:handle                // create game and join

GET  /api/host/:handle/map/:name      // create game with named map and join

GET  /api/game/:game_id/join/:handle  // join game

```

### Player API

```

GET  /api/game/:game_id/player/:secret/info             // get game state

GET  /api/game/:game_id/player/:secret/move/:direction  // move buggy 1 square

```

### Host API

```

GET  /api/game/:game_id/player/:secret/reset         // resets all players' positions and purses

GET  /api/game/:game_id/player/:secret/kick/:handle  // kicks player out of game

```

### RUN LOCALLY

Install Elixir: https://elixir-lang.org/install.html

    mix deps.get

    mix compile

    mix start

goto http://localhost:4000

    SANDBOX=true mix start  # run with rate limiting turned off