From 7d69ddf24dbf99895f49178200ede95ee475e885 Mon Sep 17 00:00:00 2001 From: Kenson Johnson <94240602+kensonjohnson@users.noreply.github.com> Date: Tue, 20 Aug 2024 12:27:27 -0500 Subject: [PATCH] Update readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c7e8e1..2e6e4f7 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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