From b01b39b00ebfd4e43ec03ac5d9f86f44cc485250 Mon Sep 17 00:00:00 2001 From: Jake Funke Date: Fri, 10 Mar 2017 04:54:38 +0000 Subject: [PATCH] Update readme --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++- botany.py | 2 +- menu_screen.pyc | Bin 6061 -> 0 bytes 3 files changed, 61 insertions(+), 2 deletions(-) delete mode 100644 menu_screen.pyc diff --git a/README.md b/README.md index 2e22c6d..b6dcbb1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,61 @@ # botany -command line virtual plant buddy + +by Jake Funke - jifunks@gmail.com - tilde.town/~curiouser - +http://jakefunke.online/ + +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 +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 +* Beautiful curses-based menu system +* 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` +* Data file is created in your home (~) directory, along with a JSON file that you can use in your own apps. +``` +{ +"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 +} +``` + +###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!* + +###to-dos +* Add ASCII plant display +* Add plant inspection ('look' function) +* Add garden display ('garden' function) + * Show other plants living in neighborhood + * Allows you to water plants +* Plant end of life (seeding/pollination + * Plant pollination - cross-breed with neighbor plants to unlock second-gen plants +* Global events + * Server API to have rain storms, heat waves, insects + + +## requirements +* Unix-based OS (Mac, Linux) +* Python 2.x + +## credits +* thank you tilde.town for inspiration! +* Thank you @etkirsch for [this +gist](https://gist.github.com/etkirsch/53505478f53aeeac24a5) - python curses +can be nightmarish! diff --git a/botany.py b/botany.py index d7c7918..dad1886 100644 --- a/botany.py +++ b/botany.py @@ -63,7 +63,7 @@ from menu_screen import * # myscreen.getch() # # curses.endwin() - +# TODO: garden file json should be prettier. class Plant(object): # This is your plant! diff --git a/menu_screen.pyc b/menu_screen.pyc deleted file mode 100644 index 26c648cc7c6b0a8330203631de506fdaaa1cc520..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6061 zcmeHL-Etg974DgpR@${>$#!g6u@g^}O1!2LJAaU1l3>|#h>0V^NQn}a!_@3dOFPnN zW;NYwX(6UkrMv>g1vgyq5>!DIJOVe|@f6%~1K)RgR$4-(NX#vgx^?=$`}}<8oN4@h zw*9N$|LK!N)jtjVzlCDDs8alSDpzXrnD*4BH|qD*raz(^YO^t-C)DP|h@MoNlPdL< zZmKOTY^X1lI#TM>%_(lZ)|tRD*+22KYTF?13@W434|Os4w;SE&jWjA0cRo+{xEYTH zje0_Ti5ubMN$JP2O(B{poe}~^P75)u(v}b{m9~XwtMrr*r&PGsnc;CiMztIyd2CE@ z(94ou5O4Q3_H@uItE#L_P;Ld?L6)aku^q%g!Uvd_yD^>-?BN}O85*ni5+B=< zxsxb&P|S;-QdX(Ym5MxNeYMjdW7wRK<|LaQ2b#y!)G>u8cg4I?t1MtqW2wsH29v z=EeF7+;>sNo|a{ol)bEWo}r9*r)McCh~`N7kFn7e^|`O2fc4IEJaY7+C22sIYn>_Z z%brGcugGi`=h@F=o0Ua|9+iQO$~IZW)wZ^l8U@O%c0j1k^Bf`5--~mj?I}>%XcwKz zLMJoJQ#fRjO1kl1>q5w))Jd;&le?9UcV!=g6K#}~d0E+MEapBD&X9S#df1OsIk}(5 zg_RZk7}^oJHkC}M2wDZ@u?=*9lqEJxc8y!Y#gS|CY5Fj;_6&%uz~n(fM%Z$DJJ)gt za9}S!93BcANR5a?+mc0@jrws`$=-J!+8x9>0C`CzQQ@&3K_yJC&#km|}dtedmK?c^PC08Ew)7aMUkMiu1mdmYI11&StSnuI6 z6qc}7s3g~M)gfPD~J(>EZUtQ;6!-RPD! zE`~Q~osnC2y+4!}MG+Msil_=kcJW)@oY$7$S#REJd1t-zs9WA8e-ZSIcL{Xcm#eO4 zwwA)$pljJkC@~gV{~d1nLsYZ^)V2LO3xhd|c|?M1G@%9`Okz?NI1qs8tqC*Ci`ZzT ziVsW>JDfSlY)^n`8;mUis9L7r~j`mZ|_G9=ThiVIkw>qBtMtZ$z>m14gKg1oPMm;{f$GaPJ5*6D-|@sV#|f z64hgKwZpSTTjPFT7ist!+R`bka7}c%=YMnc3;C35D27m`{COx_LTIDrllh`Oham9S z$DSIlsKeLg?e5+0)>?H`11OYBaUOLI8s>Cue@1PvLp+VQQCw9Mc-d}SRYrLLV}V{b z2+gSdPT{Ff(njs74X?SJ*g>414wP84->JG z6XhIjMhL{HTmK{q8or7hsNLo%RLXC94Z(*Q?~Hf4L8K6&@r~0cBDB9kjO050L@L5% z5zCkh7pXvL@yEFc0h|CPoKW1bggP9alHqA}gyBO&!vrRB0N!3iz4F<^k@RO2Bnt)L z@T}VPRrMR8PqUx)fqwi+0EKA_kTskxDER0Fw>2?Co~j;>_=S6&Qt6CJ zXUBHh|MhtscMT&_z3Vh?9&ni3Krg1T171wXtA1T3cUUU3u`)x*)%-S&nW$ zxW6I}22cPyZ(w4s3qi>63eS3l)ibQ-Sv||@94j!ud3#<{7Q(CrgKY+%#^|SJ1OlTy zphUda4}ZXwH(9;S>K#;LE{dGbid4HW$l|}T!(4~-$4>+VZ(`xQDCRq;=%wbpE8Z3V zGW^sW!h-MlY|VH}sM*^9K+O3yJP_B9eb~>?INYe!)O;!gTo_DEZ1Xq{fQs%QCvb6l zQ>IO+>Yfll0w^eq8AyPjzs8mQhT2FK)Rbqfimr92Yay{qm>kZL67G|!A@$jbfcy&i z#_%305u?eq?ss^10oEtt8Wr*(iu3J_nL3=Bb+E~M(mL*N#y?QiFe1iDXC|(m5Oz(5 z9I!Oh;u=Tb2r+W29!cwNs15QBux)ozkPo?*fGd;~Fb7rV8In2??~a7xY#dYQjlHZ0-$Nr5gXg*r?tU7rJlI$jOK0PwpPa-%0w1+ge!MHdkA2`r*Ce+EHafB>geHBVwpH(nB9 zkBp1v;2q09#Lg)URXGvh>3oTIjUwfFFr#OTOeC0U2?p+761U1Qn|-|<-D zcZ5;!*Dku>fj69j7C|B5TK2zieiRd0BLn7zJ7lrQejP~;L(zjCP(L7yrzPAB!YcHQ z;{7_fSrsD{T(sg$PVz%zK7iy8be(2XR<&o*k90K*UV8&+Ng3<{Jc7)& zxgYL-J@{?_7v`Q(4o05o9eO6)lbcm-=krp{KpP)g3gH0uV(R!@uvda7S+P}uL+$uc zoaJ#hXOB2yrl5H2&1>ziagO8Ncn1=tm%hvtKvIDH~` zNOTb7hFQTDu{Y9pBR%e8<^Sm98HD{7#Sq670-{;uMeG`85Et4n;8B~R@vtq(2S(l4Ome{0&2+3H9_fEtj)VIjFv4iB-lFT(5O|P{$*J?Fe zbFF7v?bgNCk|43Ty)fc&Z?g(mNmRu5@f(6frDSc{-N84L5Y$*u`7LiHJbK%4