2017-03-06 21:36:27 +00:00
# botany
2017-03-15 21:26:06 +00:00
2017-03-15 21:42:34 +00:00
2017-03-14 22:50:03 +00:00
by Jake Funke - jifunks@gmail.com - tilde.town/~curiouser - http://jakefunke.online/
2017-03-10 04:54:38 +00:00
A command line, realtime, community plant buddy.
You've been given a seed that will grow into a beautiful plant.
Check in and water your plant every 24h to keep it growing. 5 days without water = death. Your plant depends on you to live!
*(work in progress)*
## getting started
2017-03-10 19:06:41 +00:00
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!
2017-03-15 21:35:14 +00:00
*Note - botany.py must initially be run by the user who cloned/unzipped
botany.py - this initalizes the shared data file permissions.*
2017-03-15 21:42:34 +00:00
2017-03-10 04:54:38 +00:00
## features
2017-03-14 22:50:03 +00:00
* Curses-based menu system
2017-03-10 04:54:38 +00:00
* 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`
2017-03-15 21:35:14 +00:00
* Data file is created in the user's home (~) directory, along with a JSON file that can be used in other apps.
2017-03-15 21:42:34 +00:00
2017-03-10 04:54:38 +00:00
```
{
"description":"common singing blue seed-bearing poppy",
"file_name":"/Users/jakefunke/.botany/jakefunke_plant.dat",
"age":"0d:2h:3m:16s",
"score":1730,
"owner":"jakefunke",
"is_dead":false,
"last_watered":1489113197
}
```
2017-03-15 21:35:14 +00:00
### testing features
2017-03-10 04:54:38 +00:00
* *Plant lifecycle is currently extremely short for testing - bear with me!*
2017-03-15 21:35:14 +00:00
* *Plant mutation happens more frequently than it will in final version.*
2017-03-10 04:54:38 +00:00
2017-03-15 21:35:14 +00:00
### to-dos
2017-03-10 04:54:38 +00:00
* Add ASCII plant display
2017-03-13 05:28:34 +00:00
* Finish garden display ('garden' function)
* Allows you to water neighbor's plants
2017-03-14 22:50:03 +00:00
* Plant end of life (seeding/pollination)
2017-03-10 04:54:38 +00:00
* Plant pollination - cross-breed with neighbor plants to unlock second-gen plants
* Global events
* Server API to have rain storms, heat waves, insects
2017-03-14 22:50:03 +00:00
* Name your plant
* Reward for keeping plant alive
* Hybridization, multiple generations, lineage
2017-03-10 04:54:38 +00:00
## requirements
* Unix-based OS (Mac, Linux)
* Python 2.x
## credits
* thank you tilde.town for inspiration!
2017-03-10 18:15:22 +00:00
* Thank you @etkirsch for [this gist ](https://gist.github.com/etkirsch/53505478f53aeeac24a5 ) - python curses can be nightmarish!
