Skip to content

Commit

Permalink
Update README.md for release
Browse files Browse the repository at this point in the history
  • Loading branch information
opstic authored Jul 2, 2023
1 parent f01bcc4 commit 6cde411
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,20 @@ Built using Bevy engine and Rust.

## Usage

~~Grab the latest binary from [releases](https://github.com/opstic/gdclone/releases) then just run it.~~
Grab the latest binary from [releases](https://github.com/opstic/gdclone/releases) then just run it.

**No release yet, sorry :(**
A GD install and valid CCLocalLevels.dat are required.

*You'll have to build the app yourself for now.*
**Binaries for Linux aren't available, so you'll need to compile it yourself.**

*Support for web and mobile platforms are planned.*

Controls are WASD to move, use arrow keys to move slower, hold left-shift to move faster.

Q and E to zoom in and out.

Use Esc to exit out of a level.

## Screenshots

<img src="https://github.com/opstic/gdclone/raw/main/assets/screenshots/the_eschaton_1.png" width="1080">
Expand All @@ -30,7 +34,7 @@ Q and E to zoom in and out.

### Credits

Thanks to [@maxnut](https://github.com/maxnut) for providing code to extract `object.json`.
Thanks to [@maxnut](https://github.com/maxnut) for providing part of the code to extract `object.json`.

#### License
<sub>
Expand Down

0 comments on commit 6cde411

Please sign in to comment.