Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Add more sections to the README with features, links to articles in the
wiki, and some screenshots.
  • Loading branch information
Fahien committed Dec 20, 2021
1 parent 4e72328 commit 48d8be8
Showing 1 changed file with 82 additions and 3 deletions.
85 changes: 82 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,50 @@
# RustSpot
<div align="center">

Experimenting Rust gamedev on [ODROID-GO Advance](https://www.odroid.co.uk/ODROID-GO-Advance).
# RustSpot 🕹️

## Windows

**Experimenting Rust gamedev on [ODROID-GO Advance](https://www.odroid.co.uk/ODROID-GO-Advance).**

</div>

This project started as a relatively small experiment targeting a handheld-console, but it has grown while following a [community-driven OpenGL learning effort](https://forum.gameloop.it/d/729-learnopengl-imparare-le-basi-della-computer-graphics).


<table><tr><td>
<div align="center">

![RustSpot](https://raw.githubusercontent.com/wiki/Fahien/rustspot/image/cover.png)

_Shader variants in action_

</div>
</td></tr></table>


## Features

- Data-driven design
- Scene graph
- Shadow mapping
- glTF loading
- Physically Based Rendering
- Normal mapping

## Articles

Have a look at the [wiki](https://github.com/Fahien/rustspot/wiki) to find a list of technical articles written during development.

- [Renderer](https://github.com/Fahien/rustspot/wiki/Renderer)
- [Sky shader](https://github.com/Fahien/rustspot/wiki/Sky)
- [Grass shader](https://github.com/Fahien/rustspot/wiki/Grass)
- [Shader variants](https://github.com/Fahien/rustspot/wiki/Shader-Variants)

## Build

RustSpot works on Linux, MacOS, and Windows, but it will need Rust and SDL2.
It should not be difficult to setup the required dependencies and run the demos, but do not hesitate to contact me if you need any help.

### Windows

To link SDL2 in Windows, you can:

Expand All @@ -15,3 +57,40 @@ To link SDL2 in Windows, you can:
```sh
RUSTFLAGS='-L <SDL2>/build/Release' cargo build
```

## Screenshots

<div align="center">

<table>
<tr>
<td>

![Sponza screenshot](https://raw.githubusercontent.com/wiki/Fahien/rustspot/image/sponza.png)

_First render of Sponza_

</td>
</tr>

<tr>
<td>

![SciFi Helmet](https://raw.githubusercontent.com/wiki/Fahien/rustspot/image/scifi.png)

_Physically Based Rendering_

</td>
</tr>

<tr>
<td>

![Normal mapping](https://raw.githubusercontent.com/wiki/Fahien/rustspot/image/lion.png)

_Normal mapping in action_

</td>
</tr>

</div>

0 comments on commit 48d8be8

Please sign in to comment.