|
1 | 1 | <br /> |
2 | 2 | <p align="center"> |
3 | | - <img src="assets/icon.png" alt="Logo" width="80" height="80"> |
| 3 | + <img src="assets/icon.png" alt="Logo" width="64" height="64"> |
4 | 4 |
|
5 | 5 | <h1 align="center">Human Computer Simulator</h1> |
6 | 6 |
|
7 | 7 | <p align="center"> |
8 | | - A game where you get to become your favorite algorithm or data structure! |
9 | | - <br /> |
10 | | - <a href="https://github.com/DanielZTing/human-computer-simulator/issues/new?template=bug_report.md">Report Bug</a> |
11 | | - · |
12 | | - <a href="https://github.com/DanielZTing/human-computer-simulator/issues/new?template=feature_request.md">Request Feature</a> |
| 8 | + Become your favorite sorting algorithm! |
13 | 9 | </p> |
14 | 10 | </p> |
15 | 11 |
|
16 | | -## Table of Contents |
17 | | - |
18 | | -* [About the Project](#about-the-project) |
19 | | -* [Getting Started](#getting-started) |
20 | | - |
21 | | -## About The Project |
22 | | - |
23 | 12 |  |
| 13 | +Have you ever wondered what it feels like to be a sorting algorithm‽ Now you can find out! In *Human Computer Simulator*, you control an algorithm operating on an array, trying to sort as fast as possible. With 10 different levels, a cool visualization, and optional sound effects, you can fulfill your sorting dreams... |
24 | 14 |
|
25 | | -You may have come across the famous [15 Sorting Algorithms in 6 Minutes](https://www.youtube.com/watch?v=kPRA0W1kECg) video by [Timo Bingmann](https://github.com/bingmann) at some point in your computer science career. There is currently no shortage of neat visualizations of all kinds of algorithms, but what if you could become the algorithm itself? |
26 | | - |
27 | | -In *Human Computer Simulator*, you control an algorithm operating on some data structure. Right now, the game is limited to sorting arrays. The end vision is to have a library of interactive, playable levels on anything from a search on a binary tree to Dijkstra's shortest path on a graph. |
| 15 | +A demo (large download warning: ~5 MB gzipped) is available on this repository's [Github Pages](https://danielzting.github.io/human-computer-simulator). It requires a desktop browser with support for WebAssembly and WebGL. |
28 | 16 |
|
29 | | -It's written using the Godot game engine and licensed with [almost no restrictions](LICENSE.txt). Use it to make a lecture a bit more interesting, review for an assignment, or just kill time. Hope you enjoy. |
| 17 | +## Anti-pitch |
30 | 18 |
|
31 | | -## Getting Started |
| 19 | +This is beta software, so there will inevitably be things that are confusing, broken, or straight up wrong. See the [issues](https://github.com/DanielZTing/human-computer-simulator/issues) for a list of caveats and don't hesitate to open another one if you find something new. |
32 | 20 |
|
33 | | -This software is in an alpha stage of development and I do not plan on releasing ready-to-run builds until a stable v1.0 release. However, it is very easy to run and hack the source code yourself. Just grab the lightweight free and open source [Godot game engine](https://godotengine.org/download), import the `project.godot` file, and hit the play button. |
| 21 | +## Contributing |
34 | 22 |
|
35 | | -A demo version (large download warning: ~20 MB) is available on this repository's [Github Pages](https://danielzting.github.io/human-computer-simulator). It requires a desktop browser with support for WebAssembly and WebGL; mobile is not currently supported. Since this is still in alpha, some things might be dumb, make no sense whatsoever, or just break outright. I welcome any feedback you may have. |
| 23 | +I welcome any bug reports or feature requests. Pull requests are appreciated as well, though I apologize for my code in advance. If you like this so much that you want to [throw money at me](https://venmo.com/DanielZTing), I will add any 80x24 ASCII text block of your choosing to the README and credits. |
0 commit comments