Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marekmaskarinec authored Apr 23, 2021
1 parent e3cac81 commit a3e1d04
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,19 @@ Already made stuff in tophat to get you started faster.

## example list

- space shooter - complete-ish game showing most of the engine's features
- level editor - simple tilemap editor
- snake - implementation of snake in tophat showing the absolute basics of collisions, input and rendering
- scene switching demo - example showing, how to structure your project and make scene switching

## how to run

**NOTE:** both of these assume, you are in the folder the example is in.
You have to be in the directory

### 1. tophat cmd tool
in blank directory run `tophat init`. then replace the default game file with this one. you can then use `tophat run` to run it or `tophat package linux snake` to package it.
### linux

### 2. using data in this repo
`tophat run`

1. `make build`
2. `cd examples/example-name`
3. `../../tophat`
### windows

Click the `run.bat` script.

0 comments on commit a3e1d04

Please sign in to comment.