Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dually8 committed Aug 18, 2024
1 parent 571d4ad commit 55aa80b
Showing 1 changed file with 41 additions and 30 deletions.
71 changes: 41 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,45 @@
# Foodchain game
# Food Chain game

For the GMTK Game Jam 2024 https://itch.io/jam/gmtk-2024
> For the GMTK Game Jam 2024 https://itch.io/jam/gmtk-2024
## Getting Started
You are part of nature's food chain. How long can you survive while eating and trying not to get eaten?

1. Download Godot 4.3
2. Open the project.godot file in it
3. Run it!
## Controls

- Movement: `W`,`A`,`S`,`D` for Up, Left, Down, Right respectively
- Eat: `.`
- Pause: `ESC`

We have experimental controller support

- Movement: `D-PAD`
- Eat
- Xbox: `A`
- PlayStation: `X`
- Switch: `B`
- Pause
- Xbox: `GUIDE`
- PlayStation: `OPTIONS`
- Switch: `+`

## Usage

### Browser

## TODOS

- [x] Make food hierarchy
1. Plant
2. Skunk
3. Wolf
4. Bear
5. Human
- [x] Create HP system
- [x] Create hunger system
- [x] Instructions screen (?)
- [x] When human, everything is predator, except for carrot
- [x] _IF_ we have time, make carrots not run away LOL
- [x] enemies clip through static sprites
- [x] Adjusted Hunger Drain
- [x] Added audio stream player 2d to enemy
- [x] Added new audio files for enemy
- [x] Updated main menu
- [x] Added controls information
- [ ] Human never dies
- [ ] Added avoidance to static sprites, might need to check pathing again.
- [ ] We need to seriously remove some of these unused files. It's slowing the game down.
- [ ] **How do we build and share?**
1. Go to the [game page on itch.io](https://dually8.itch.io/foodchain)
2. Click "Run game"

### Windows

1. Download the release
2. Run `foodchain.exe`
- You may run into some windows security thing. That's because I can't sign the exe, so please excuse me for that. If you don't feel comfortable running the exe, feel free to try the [browser version](#browser)

## Building and running the project

1. Download [Godot 4.3](https://godotengine.org/)
2. Open the `project.godot` file in it
3. Run it!

## Credits

Expand All @@ -53,4 +62,6 @@ For the GMTK Game Jam 2024 https://itch.io/jam/gmtk-2024
- [xenophero](https://xenophero.itch.io/plants-nature-sprites)
- Art
- [kenney](https://www.kenney.nl/)
- Input icons
- Input icons
- [dan-velasquez-art](https://dan-velasquez-art.itch.io/)
- UI Art

0 comments on commit 55aa80b

Please sign in to comment.