https://github.com/patryk27/shorelark

evolution genetic-algorithm life neural-network rust simulation webassembly

Last synced: 7 months ago
JSON representation

Simulation of life & evolution

Host: GitHub
URL: https://github.com/patryk27/shorelark
Owner: Patryk27
License: mit
Created: 2020-11-24T19:36:40.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-04-04T15:56:11.000Z (over 1 year ago)
Last Synced: 2025-04-09T20:08:54.018Z (7 months ago)
Topics: evolution, genetic-algorithm, life, neural-network, rust, simulation, webassembly
Language: Rust
Homepage: https://pwy.io/en/posts/learning-to-fly-pt1/
Size: 621 KB
Stars: 218
Watchers: 5
Forks: 22
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

# 🐦 Shorelark

Simulation of evolution, powered by neural networks, genetic algorithms and
high school math:

![screenshot](./readme/screenshot.png)

Feeling curious? I've described the implementation _ab ovo_ on my blog:
[Learning to Fly](https://pwy.io/posts/learning-to-fly-pt1).

## Building

### Using Cargo and npm

Requires `cargo`, `npm` and `wasm-pack` (0.11.0):

```bash
# Clone the repository
$ git clone https://github.com/Patryk27/shorelark
$ cd shorelark

# Build Rust code
$ cd libs/simulation-wasm
$ wasm-pack build --release

# Build TypeScript code
$ cd ../../www
$ npm install

# Start the application
$ npm run start

# Now simply open `http://localhost:8080` in your web browser :-)
```

### Using Nix

```bash
# Clone the repository
$ git clone https://github.com/Patryk27/shorelark
$ cd shorelark

# Build the application
$ nix build

# Start the application
$ nix run nixpkgs#php -- -S localhost:8080 -t result

# Now simply open `http://localhost:8080` in your web browser :-)
```

## Usage

Shorelark contains an in-game introduction - just read what the terminal on the
left side says and have fun!

## License