Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kensonjohnson committed Aug 20, 2024
1 parent f8a92f3 commit 7d69ddf
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
# Roguelike in Go

This is a simple roguelike game written in Go. It is based on the tutorial by [Fat Old Yeti](https://www.fatoldyeti.com/categories/roguelike-tutorial/), with some small modifications, like embedding the static assets in the binary.
This is a simple roguelike game written in Go. Original inspiration was the tutorial by [Fat Old Yeti](https://www.fatoldyeti.com/categories/roguelike-tutorial/), now heavily modified and expanded.

You can [try the game here](https://kensonjohnson.github.io/roguelike-in-go/), via GitHub Pages and WebAssembly.

## Features

- Built entirely in [Go](https://go.dev/)
- Uses [Ebiten](https://ebitengine.org/) for graphics and input

## Roadmap

- [x] Randomly generated levels
- [x] Simple combat system
- [x] Basic AI for enemies
- [ ] Inventory system
- [ ] Equipment system
- [ ] Town and NPCs
- [ ] Character progression
- [ ] Quests (Maybe)

## Getting started

To run the game, you need to have Go installed. You can download it from the [official website](https://golang.org/) or install it using your package manager.
Expand All @@ -14,6 +30,12 @@ Obviosuly, you also need to clone this repository:
git clone git@github.com:kensonjohnson/roguelike-in-go.git
```

Fetch the dependencies:

```bash
go mod tidy
```

Then, you can run the game using the following command:

```bash
Expand Down

0 comments on commit 7d69ddf

Please sign in to comment.