punky
/
botany
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update readme

pull/1/head
Jake Funke 2017-03-14 22:50:03 +00:00
parent bd56dd38a4
commit 7faf3a4dd0
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,7 +1,6 @@
# botany # botany
by Jake Funke - jifunks@gmail.com - tilde.town/~curiouser - by Jake Funke - jifunks@gmail.com - tilde.town/~curiouser - http://jakefunke.online/
http://jakefunke.online/
A command line, realtime, community plant buddy. A command line, realtime, community plant buddy.
@ -14,7 +13,7 @@ Check in and water your plant every 24h to keep it growing. 5 days without water
botany is designed for unix-based systems. Clone into a local directory using `git clone https://github.com/jifunks/botany.git`. Run with `python botany.py`. Water your seed to get started. You can come and go as you please and your plant continues to grow. Make sure to come back and water every 24 hours or your plant won't grow. If your plant goes 5 days without water, it will die! botany is designed for unix-based systems. Clone into a local directory using `git clone https://github.com/jifunks/botany.git`. Run with `python botany.py`. Water your seed to get started. You can come and go as you please and your plant continues to grow. Make sure to come back and water every 24 hours or your plant won't grow. If your plant goes 5 days without water, it will die!
## features ## features
* Beautiful curses-based menu system * Curses-based menu system
* Persistent aging system that allows your plant to grow even when app is closed * Persistent aging system that allows your plant to grow even when app is closed
* Community leaderboard (for shared unix servers) created in program directory `garden_file.json` * Community leaderboard (for shared unix servers) created in program directory `garden_file.json`
* Data file is created in your home (~) directory, along with a JSON file that you can use in your own apps. * Data file is created in your home (~) directory, along with a JSON file that you can use in your own apps.
@ -31,19 +30,19 @@ botany is designed for unix-based systems. Clone into a local directory using `g
``` ```
###testing features ###testing features
* *In current alpha status, you can kill your plant with the kill command. This is permanent!*
* *Plant lifecycle is currently extremely short for testing - bear with me!* * *Plant lifecycle is currently extremely short for testing - bear with me!*
###to-dos ###to-dos
* Add ASCII plant display * Add ASCII plant display
* Add plant inspection ('look' function)
* Finish garden display ('garden' function) * Finish garden display ('garden' function)
* Allows you to water neighbor's plants * Allows you to water neighbor's plants
* Plant end of life (seeding/pollination * Plant end of life (seeding/pollination)
* Plant pollination - cross-breed with neighbor plants to unlock second-gen plants * Plant pollination - cross-breed with neighbor plants to unlock second-gen plants
* Global events * Global events
* Server API to have rain storms, heat waves, insects * Server API to have rain storms, heat waves, insects
* Name your plant
* Reward for keeping plant alive
* Hybridization, multiple generations, lineage
## requirements ## requirements
* Unix-based OS (Mac, Linux) * Unix-based OS (Mac, Linux)