chore: rename to "Algorithm Simulator"

danielzting · danielzting · commit 79225b6c9b40 · 2020-09-14T16:25:24.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+build/
+
 # Godot-specific ignores
 .import/
 export.cfg
diff --git a/CREDITS.md b/CREDITS.md
@@ -1,4 +1,4 @@
-This project is made possible by open source projects; their required copyrights are listed below.
+This project is made possible by open source projects; their required license texts are listed below.
 
 # [Godot](https://godotengine.org)
 Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. Copyright (c) 2014-2020 Godot Engine contributors.
@@ -12,50 +12,3 @@ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR I
 # [FreeType](https://www.freetype.org)
 Portions of this software are copyright © 2019 The FreeType
 Project (www.freetype.org). All rights reserved.
-
-# [Hack](https://sourcefoundry.org/hack)
-The work in the Hack project is Copyright 2018 Source Foundry Authors and licensed under the MIT License
-
-The work in the DejaVu project was committed to the public domain.
-
-Bitstream Vera Sans Mono Copyright 2003 Bitstream Inc. and licensed under the Bitstream Vera License with Reserved Font Names "Bitstream" and "Vera"
-
-### MIT License
-
-Copyright (c) 2018 Source Foundry Authors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-### BITSTREAM VERA LICENSE
-
-Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is a trademark of Bitstream, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of the fonts accompanying this license ("Fonts") and associated documentation files (the "Font Software"), to reproduce and distribute the Font Software, including without limitation the rights to use, copy, merge, publish, distribute, and/or sell copies of the Font Software, and to permit persons to whom the Font Software is furnished to do so, subject to the following conditions:
-
-The above copyright and trademark notices and this permission notice shall be included in all copies of one or more of the Font Software typefaces.
-
-The Font Software may be modified, altered, or added to, and in particular the designs of glyphs or characters in the Fonts may be modified and additional glyphs or characters may be added to the Fonts, only if the fonts are renamed to names not containing either the words "Bitstream" or the word "Vera".
-
-This License becomes null and void to the extent applicable to Fonts or Font Software that has been modified and is distributed under the "Bitstream Vera" names.
-
-The Font Software may be sold as part of a larger software package but no copy of one or more of the Font Software typefaces may be sold by itself.
-
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
-
-Except as contained in this notice, the names of Gnome, the Gnome Foundation, and Bitstream Inc., shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Font Software without prior written authorization from the Gnome Foundation or Bitstream Inc., respectively. For further information, contact: fonts at gnome dot org.
diff --git a/README.md b/README.md
@@ -1,23 +1,22 @@
-<br />
 <p align="center">
   <img src="assets/icon.png" alt="Logo" width="64" height="64">
 
-  <h1 align="center">Human Computer Simulator</h1>
+  <h1 align="center">Algorithm Simulator</h1>
 
   <p align="center">
     Become your favorite sorting algorithm!
   </p>
 </p>
 
 ![Level select screen](assets/levels.png)
-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...
+It seems like there's a simulator for everything, whether it be flights, goats, or yandere. But have you ever wondered what it feels like to be a sorting algorithm‽ No? Well, now you can find out anyways! In *Algorithm Simulator*, inspired by Timo Bingmann's widely viewed [15 Sorting Algorithms in 6 Minutes](https://www.youtube.com/watch?v=kPRA0W1kECg), you control an algorithm operating on an array, trying to sort as fast as possible. With ten different levels, a cool visualization, and sound effects, you can fulfill your sorting dreams...
 
-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.
+A demo (large download warning: ~5 MB gzipped) is available on this repository's [Github Pages](https://danielzting.github.io/algorithm-simulator). It requires a desktop browser with support for WebAssembly and WebGL. Use it to make a lecture a little more interesting, study for your sorting algorithms certification, or annoy the neighbors with the sound...
 
 ## Anti-pitch
 
-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.
+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/algorithm-simulator/issues) for a list of caveats and don't hesitate to open another one if you find something new.
 
 ## Contributing
 
-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.
+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) for some reason, I will add any 80x24 ASCII text block of your choosing to the credits.
diff --git a/assets/levels.png b/assets/levels.png
diff --git a/levels/cycle_sort.gd b/levels/cycle_sort.gd
@@ -7,11 +7,12 @@ Cycle sort looks at the first element and finds its correct final
 position by counting the number of elements smaller than it. Then it
 saves the element at that index, writes the first element there, and
 repeats the process with the saved element. For the sake of
-demonstration, in the actual level, swaps are used instead.
+demonstration, the actual level uses swaps instead and skips over
+elements already in place.
 
 This results in a quadratic runtime but gives it the special property
-of being optimal in the number of writes to the array. This makes cycle
-sort useful in situations where writes are very expensive.
+of being optimal in the number of writes to the array, making it useful
+when writes are expensive.
 """
 const CONTROLS = """
 If the highlighted element is less than the element below the blue
diff --git a/project.godot b/project.godot
@@ -110,7 +110,7 @@ _global_script_class_icons={
 
 [application]
 
-config/name="Human Computer Simulator"
+config/name="Algorithm Simulator"
 run/main_scene="res://scenes/menu.tscn"
 boot_splash/image="res://assets/splash.png"
 config/icon="res://assets/icon.png"
diff --git a/scenes/menu.tscn b/scenes/menu.tscn
@@ -28,7 +28,7 @@ script = ExtResource( 1 )
 [node name="Title" type="Label" parent="MainMenu"]
 margin_right = 1199.0
 margin_bottom = 19.0
-text = "Human Computer Simulator"
+text = "Algorithm Simulator"
 uppercase = true
 
 [node name="Display" type="MarginContainer" parent="MainMenu"]
@@ -44,9 +44,9 @@ __meta__ = {
 [node name="InstructionsContainer" type="MarginContainer" parent="MainMenu/Display"]
 visible = false
 margin_left = 484.0
-margin_top = 164.0
+margin_top = 146.0
 margin_right = 714.0
-margin_bottom = 434.0
+margin_bottom = 451.0
 size_flags_horizontal = 4
 size_flags_vertical = 4
 script = ExtResource( 3 )
@@ -55,12 +55,18 @@ script = ExtResource( 3 )
 margin_left = 20.0
 margin_top = 20.0
 margin_right = 210.0
-margin_bottom = 250.0
+margin_bottom = 285.0
 custom_constants/separation = 16
 
+[node name="GitHub" type="Button" parent="MainMenu/Display/InstructionsContainer/Instructions"]
+margin_right = 190.0
+margin_bottom = 19.0
+text = "Fork me on GitHub!"
+
 [node name="Controls" type="HBoxContainer" parent="MainMenu/Display/InstructionsContainer/Instructions"]
+margin_top = 35.0
 margin_right = 190.0
-margin_bottom = 195.0
+margin_bottom = 230.0
 custom_constants/separation = 20
 
 [node name="Keys" type="Label" parent="MainMenu/Display/InstructionsContainer/Instructions/Controls"]
@@ -93,9 +99,9 @@ confirm"
 align = 2
 
 [node name="Button" type="Button" parent="MainMenu/Display/InstructionsContainer/Instructions"]
-margin_top = 211.0
+margin_top = 246.0
 margin_right = 190.0
-margin_bottom = 230.0
+margin_bottom = 265.0
 text = "OK"
 
 [node name="Spacing" type="Control" parent="MainMenu"]
@@ -133,6 +139,7 @@ text = "CREDITS"
 [node name="Timer" type="Timer" parent="."]
 wait_time = 0.25
 autostart = true
+[connection signal="pressed" from="MainMenu/Display/InstructionsContainer/Instructions/GitHub" to="MainMenu" method="_on_GitHub_pressed"]
 [connection signal="pressed" from="MainMenu/Display/InstructionsContainer/Instructions/Button" to="MainMenu" method="_on_Button_pressed"]
 [connection signal="pressed" from="MainMenu/Buttons/Help" to="MainMenu" method="_on_Help_pressed"]
 [connection signal="pressed" from="MainMenu/Buttons/Start" to="MainMenu" method="_on_Start_pressed"]
diff --git a/scripts/menu.gd b/scripts/menu.gd
@@ -31,3 +31,6 @@ func _on_Button_pressed():
     $Display/InstructionsContainer.hide()
     $Display/HBoxContainer.show()
     $Buttons/Start.grab_focus()
+
+func _on_GitHub_pressed():
+    OS.shell_open("https://github.com/DanielZTing/algorithm-simulator")

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+build/`
	`2`	`+`
`1`	`3`	`# Godot-specific ignores`
`2`	`4`	`.import/`
`3`	`5`	`export.cfg`