1e658fe8fe4b

Add a README
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sat, 12 Dec 2015 20:26:29 +0000
parents 5e2ad425aa5a
children 251301483006
branches/tags (none)
files README.markdown README.md

Changes

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Sat Dec 12 20:26:29 2015 +0000
@@ -0,0 +1,81 @@
+    :'######::'####:'##:::::::'########:
+    '##... ##:. ##:: ##:::::::... ##..::
+     ##:::..::: ##:: ##:::::::::: ##::::
+    . ######::: ##:: ##:::::::::: ##::::
+    :..... ##:: ##:: ##:::::::::: ##::::
+    '##::: ##:: ##:: ##:::::::::: ##::::
+    . ######::'####: ########:::: ##::::
+    :......:::....::........:::::..:::::
+
+Silt is my little game for [Ludum Dare
+34](http://ludumdare.com/compo/2015/12/09/welcome-to-ludum-dare-34/).  The theme
+this time was a tie between "Growing" and "Two Button Controls".
+
+![Preview](https://i.imgur.com/hZlAI60.gif)
+
+## What is it?
+
+You are the god of a toroidal world.  The world is inhabited by creatures who
+reproduce (and mutate).
+
+What you choose to do is up to you.  There's no set goal.  If you're feeling
+generous, help the creatures prosper and thrive.  Or change the environment to
+guide their evolution in a particular direction.  Or maybe you're a vengeful god
+and want to destroy all life.
+
+## Controls
+
+*Not all of this is implemented yet.*
+
+The theme is "Two Button Controls", but I've bent that a little bit.
+
+* **`hjkl`** to move your view of the world.
+* **`arrow keys`** to move the view a bit faster.
+* **`r`** reset the world.
+* **`escape`** quit the game.
+
+You can tick the world along one step at a time.
+
+* **`123456789`** to "tick" the world and let the creatures live.  **`1`** runs
+  for one tick, **`2`** for ten ticks, **`3`** for one hundred ticks, etc.
+* **`space`** a single tick, just like **`1`**.
+
+Those are the basic controls.  To actually interact with the world you have two
+options:
+
+* **`w`** make the world one degree hotter.
+* **`s`** make the world one degree colder.
+
+## Game Mechanics
+
+*Not all of this is implemented yet.*
+
+Creatures have energy.  They can spend it to stay alive, and get it by being
+near food/water.
+
+Creatures have a body temperature that needs to stay near their ideal
+temperature.  If the world is hotter or colder than they are, they need to spend
+energy to maintain their temperature (think sweating or burning calories to warm
+up).
+
+Creatures have an insulation rating that affects how fast or slow they exchange
+heat to/from the environment (think different amounts of fur or skin).
+
+Creatures will eventually die of old age.
+
+Creatures can reproduce asexually if they have enough energy.  Their offspring
+may have mutations (different colors, ideal temperatures, amounts of insulation,
+etc).
+
+## Mysteries
+
+*Not all of this is implemented yet.*
+
+There are a couple of strange object scattered around the landscape.  Can you
+find out what they do?
+
+## License
+
+Copyright © 2015 Steve Losh and contributors
+
+Distributed under the MIT/X11 license.
--- a/README.md	Sat Dec 12 19:01:22 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-# silt
-
-FIXME: description
-
-## Installation
-
-Download from http://example.com/FIXME.
-
-## Usage
-
-FIXME: explanation
-
-    $ java -jar silt-0.1.0-standalone.jar [args]
-
-## Options
-
-FIXME: listing of options this app accepts.
-
-## Examples
-
-...
-
-### Bugs
-
-...
-
-### Any Other Sections
-### That You Think
-### Might be Useful
-
-## License
-
-Copyright © 2015 FIXME
-
-Distributed under the Eclipse Public License either version 1.0 or (at
-your option) any later version.