Merge pull request #25 from propfeds/perch

v0.2.5
propfeds · Apr 23, 2024 · 2d42316 · 2d42316
2 parents 31bd9fa + 72773ba
commit 2d42316
Show file tree

Hide file tree

Showing 59 changed files with 5,398 additions and 2,177 deletions.
diff --git a/README.md b/README.md
@@ -1,26 +1,53 @@
 # Lemma's Garden
 
-> Last night, Lemma didn't sweep away the rubbles on her old garden.
+> Last night, Lemma swept away the leaves and rubbles on her old garden.
 > 
-> You did. You are her first student in a long while.
+> You are her first student in a long while.
 
-Welcome to Lemma's Garden, an idle gardening game built on the grammar of
-Lindenmayer systems.
-
-Reminisce the story of Lemma and her late partner as she rambles about how much
-she wants to refuse supporting your study with her tight budget. Crap.
+Welcome to Lemma's Garden, an idle botanical theory built on the workings of Lindenmayer systems. Reminisce the story of Lemma, a retired teacher, and her late partner, as she rambles about things already long passed.
 
 ## Installation
 
-Navigate to [`theory.js`](./theory.js) then click on `Raw`. You will be
-delivered to the raw code page of this theory. Copy the page's URL.
+### 1. Install the Exponential Idle application.
+
+Links: [Android](https://play.google.com/store/apps/details?id=com.conicgames.exponentialidle), [iOS](https://apps.apple.com/us/app/exponential-idle/id1538487382).
+
+### 2. Acquire a dedicated save file for custom theories.
+
+This step is only for first-time players of Exponential Idle.
+
+Navigate to [`save.txt`](./save.txt) then click on `Raw`. You will be delivered to the dedicated save file. Copy the entire body of text.
+
+Launch Exponential Idle, head to `Settings > Import/Export` and click on `Import from Clipboard`.
+
+Confirm that `Lifetime f(t)` is equal to $ee44000.9.
+
+Import the save.
 
-Then, access the custom theory panel within the game (unlocked after finishing
-T9, the last theory) then enter the picking menu. Press the `+` symbol and
-paste the URL in.
+### 3. Install the theory.
+
+Navigate to [`theory.js`](./theory.js) then click on `Raw`. You will be delivered to the source code of this theory. Copy the page's URL.
+
+Then, access the custom theory panel within Exponential Idle using the bottom arrows, until you reach a screen saying `Tap to select a custom theory`. Enter the menu, press the `+` sign and paste in the URL.
+
+### 4. Tap on it to start playing.
+
+Tips:
+- Seeds have exponentially scaling costs when you buy them. Try not to make a loss from your plant, by comparing its cost to the base profit times your publication multiplier.
+- Photosynthesis outscales growth once the peak (noon) photosynthetic rate exceeds two times the average growth rate.
+- Unlocked plants always require watering to grow. Hold off watering to keep the plant at the current stage.
+- The speed setting can be accessed through the Bookshelf if one finds the theory too slow.
 
 ## Screenshots
 
-![ss](screenshots/01.png "Purple calendula alarm.")
+<img src="screenshots/pea_small.gif" alt="Pea sprout" height="50%" width="50%">
+
+> Pea sprout.
+
+<img src="screenshots/03.png" alt="Basil, meet bloom" height="50%" width="50%">
+
+> Basil, meet bloom.
+
+<img src="screenshots/02.png" alt="Colony management" height="50%" width="50%">
 
-> Purple calendula alarm.
+> Colony management.
diff --git a/TODO.md b/TODO.md
@@ -4,9 +4,9 @@
   - [Research](#research)
   - [Compost bin](#compost-bin)
   - [v0.3: Invasion](#v03-invasion)
-  - [v0.2: Education edition](#v02-education-edition)
+  - [v0.2: Wet](#v02-wet)
   - [v0.1: Slumber Seeds](#v01-slumber-seeds)
-  - [v0: Completed](#v0-completed)
+  - [v0: Axiom](#v0-axiom)
 
 ## Research
 
@@ -21,112 +21,218 @@
 - [ ] Are single-player games [that weak?](https://www.sciencedirect.com/science/article/abs/pii/S0360131522002214)
   - Hold on, collaborative and social interactions. Discord! Reddit!
 
-- [ ] Research notes
-  - Two players share progress with each other daily
-  - Some players understand the profit puzzle for calendula, some don't
-  - Players enjoy watching plants grow idly
-  - Some players can't get pruning basil
-  - Some players mistake max stage with max profit
-  - Many players are cautious about purchasing expensive items, which isn't the 
-  case usually for other theories
+Since the number of questionnaires is not so large, qualitative evaluation instead of quantitative evaluation is acceptable at least at this point. The aims of the game, such as "incorporates the mechanics of L-systems in order to provide an interesting learning experience" or "provide ways to enhance players' arithmetic skills and strategic thinking" etc, are described ex. at the beginning of "2. Methods", so you will examine the degree to which they have been achieved or not, item by item.
 
-- Let's think about it. A plant that takes 80 minutes to grow, and you have to
-do nothing. Do you feel like it could be more interesting?
+to the idea of a simple plant before calendula: that's a good idea
+the concept of l-systems is the growing sequence and such
+maybe make a first plant that features just the (a -> b, b -> ab) sequence and then add the orientation and conditions later on in its life
+
+basically it only focuses on plant growth instead of the actual l-systems , which I find a bit lacking
+you have to dig really deep to find the underlying systems behind the plants
 
 ## Compost bin
 
+- [ ] Get rid of daily income in the code
+  - Unless there's a use for it
+
 - [ ] Unlock conditions for each page in Lemma's book
 
 - [ ] Tag various stuffs with readonly
-- [x] Enums
-- [x] Use toJSON() for classes
 - [ ] Change getLoc() to just assign loc folder at start and access a property
 
-- [ ] Simple solitary flower
-  - Tulip?
-  - Buttercup
-  - No need, Cally is already easy to play
-
 - [ ] Colour schemes?
 - [ ] Timer function to measure growth
   - Device time measured by user is sufficient?
 
 - [ ] Gangsta should actually store the colony reference?
   - Internal state unfriendly
 
-- [ ] Autobuy upgrade unlocks harvest automation config
-  - Only unlocks in a future update (classmates!)
-  - Hard to implement since there's more to LG than when to harvest
-
 - [ ] Different aspect ratios hav different graph bounds
 
-- [ ] Newspapers
-- [ ] Add a Pruned commentary track
-  - 2 lazy
-
 - [ ] Compost
   - Has STAGES?
   - Supply energy
     - Don't we already have so many things that give energy
 
+- [ ] Bundle time and coordinates into the manager class
+  - [ ] Following LT's method, could also bundle the plant upgrades too
+
 - [ ] Ask Uni of Calgary about how to make Ls easier to understand
   - Provide context: making a game about the logical aspects of Ls
+  - [x] Initial email
+
+- [x] Change /sec indicators to /hr (in-game) and display 5x the value
+  - Counter-argument: all parameters display /sec
+  - [x] Test basil balance
 
-- [ ] Bulk watering when holding button
-  - Waters everything on 1 plot, not the entire garden
-  - NO bulk harvest or prune.
+- [ ] Popup title gets truncated on iOS if it exceeds 1 line
+
+- [ ] Autobuy upgrade unlocks harvest automation config
+  - Only unlocks in a future update (classmates!)
+  - Hard to implement since there's more to LG than when to harvest
+
+- [ ] Apex models for plants
+  - [ ] Pea
+  - [ ] Calendula
+  - [ ] Basil
+  - [ ] Campion
+  - [ ] Hopleek
+  - [x] Broomrape
+  - [ ] Ginger
+  - [ ] Sunflower
 
 ## v0.3: Invasion
 
-- [ ] Universal income upgrades
+- [x] Move references from loc strings to the Book class
+- [ ] Add reference to Param LSR
+- [x] Test book icon
+- [x] Add almanac access button to view menu
+- [x] Move 'view Ls' button on book menu to top side near title
+- [x] Make the column spacing x1.5 if there's no tax and make it branchless
+- [x] On confirmation dialogue, have the action described (like in L-s menu)
+- [x] Dynamical system inaccuracies
+  - [ ] Parasites sometimes eat after their hosts, resulting in loss of energy
+  - [x] basil is pruned at stg 0 (synth rate is 0), plant can only grow when watering. Watering should give multiples of 2 energy, but when evolving, some of the energy is truncated.
+- [x] Let all plots be viewable before unlocking
+  - [x] Display price before unlocking
+  - [ ] Can players perform actions in locked plots?
+- [ ] Capitalise plant names (Rose Campion instead of campion)?
+- [x] Button to display action L-systems
+- [x] Sequence view nesting is broken
+
+- [ ] Address Lemma's attitude
+  - Early game should be the time when a lot of help is needed, don't neglect your student
+  - [ ] Narration revamp
+    - Lemma should also know about L-systems and tell students what rule is being enacted
+    - [x] Narration tracks (as an integer)
+      - [ ] Should they have string keys instead?
+    - [ ] Calendula
+    - [x] Basil
+      - [x] Only need narrations for context rules
+      - [x] Basil pruned track
+      - [x] Basil unpruned track
+    - [ ] Campion
+  - [ ] Lessons
+    - [ ] L0: Ls?
+    - [ ] L1: Parametric Ls (resource accumulation)
+    - [ ] L2: Parametric Ls (Number of parameters)
+    - [ ] L3: Context Ls
+    - [ ] L4: Connections to fractals
+
+- [x] Parasites
+  - [x] Rate: for now, hardcode to be param #0 of symbol #0
+  - [x] Searching: for now, hardcode target to be the in the same plot
+  - [x] Dislodge and re-establish all links every time a colony is killed or spawned?
+    - [x] Do a sweeping scan for all links in the same plot in addColony and killColony
+
+- [x] Extra pot
+  - [x] Make pot manager wait until main manager finishes processing
+- [ ] Beehives
+
+- [x] Pre-calendula plant:
+  - [x] Pea or mung sprout
+    - [x] Narration
+  - [ ] Simple solitary flower
+    - Tulip? But tulip is much more fancier...
+    - Buttercup
+
+- [ ] Calendula
+  - [ ] Flower transforms into seed pod with lower profit
+    - Turns `K(9)` into `K(9-1.5, 0)` (to avoid further interactions) and add seed pod
+  - [ ] Singular inflorescence
+  - [x] Lower pub cost to 15p
+
+- [ ] Basil
+  - [ ] Reversible leaf decay when pruning?
+  - [ ] Align the vibes of basil & campion to make it feel smoother
+  - [ ] Two types of leaf: 2 params and 3 params
+  - [ ] Two types of signal: 0 and 1 params
+  - [x] Rewrite instructions to encourage blooming
+    - Stg 24: 'It's about to bloom soon. Cutting the bud now or watching flowers later, it's up to you.'
+    - Separate stg 26 and 27 description for basil, and only stg 27 has the signal explanation
+  - [x] Add a Pruned commentary track
+
+- [x] Rose campion
+  - [ ] Replace with normal rose in standalone game
+    - [ ] No profit per stage
+  - [ ] Shrub form
+  - [ ] Lower leaf size limit
+  - [ ] Why does it have 3 symbols on stage 1?
+    - Remove the & after adding shrub form
+  - [ ] Make the flowers' incomes easier to calculate
+  - [ ] Standalone game: spread to nearby plot instead of same plot
+  - [x] Nerf spreading rate to 1/2 or sth?
+  - [ ] Make it easy to calculate profit sum
+  - [x] Change the propagation stage since fruit only starts generating at 19?
+  - [x] Income per evolution instead of night
+  - [x] Double growth cost
+  - [ ] Flower turns into fruit faster
+  - [x] Fruit falls off
+  - [x] Add a parameter to adjust stagely income multiplier (1/2x for now?)
+  - [x] Passive income
+  - [x] Nerf growth cost from 4 to 5? Stage 21 is so fast, how about 28?
+  - [x] Extend rose campion seed period by a few stages
+  - [x] Dialogue:
+  'Oh no. Maybe luminaries were right all along. Small campion, big campion,...'
+
+- [ ] Dandelion
+  - Spawn on random plot
+    - [x] Implement RNG engine
 
 - [ ] Hopleek
   - Biting is on evolution queue instead of action?
   - [x] Leap years calculation
     - [ ] 400-year cycle wrapping
-  - [ ] Hopleek schedule
-  - [ ] Repelled by rose campions and sunflowers
-
-- [ ] Broomrape
+  - [x] Hopleek schedule
+  - [ ] Move every stage
+  - [ ] Repelled by?
+    - [ ] rose campions and sunflowers?
+    - [ ] calendula and basil?
+    - [ ] nothing.
+
+- [x] Broomrape
+  - [x] Schedule
+    - Once per 2 years? Doesn't it make broomrape faster than hopleek?
+  - [x] Propagation method
+  - [x] Models
+    - [ ] Calyxes
+    - [ ] Flowers opening
+    - [ ] Fruits droop more
+  - [x] Narrations
+  - [ ] Get into people's shoes
 
 - [ ] Ginger
+  - [ ] How to not make leaves slow down too much
+  - [ ] Pruning kills all leaves and the upper body
+  - [ ] Harvest spawns a new node? Probably not
 
 - [ ] Sunflower
 
-- [ ] Align the vibes of basil & campion to make it feel smoother
+- [ ] Universal income upgrades
+- [ ] Newspapers
 
-- [x] Rose campion as first bush plant
-  - [x] Nerf spreading rate to 1/2 or sth?
-  - [ ] Make it easy to calculate profit sum
-  - [ ] Change the propagation stage since fruit only starts generating at 19?
-  - [ ] Maximum statements
-  - [ ] Death? Propagation?
-  - [ ] Shrub form?
-  - [ ] Halve leaf synth
-  - [x] Income per evolution instead of night
-  - [ ] Double growth cost
-  - [ ] Flower turns into fruit faster
-  - [x] Fruit falls off
-  - [ ] Loading SLOW
-  - [ ] Add a parameter to adjust stagely income multiplier (1/2x for now?)
-  - [x] Passive income
-  - [x] Nerf growth cost from 4 to 5? Stage 21 is so fast, how about 28?
-  - [x] Extend rose campion seed period by a few stages
+- [x] Watering
+  - [ ] Instead of putting watering on a cooldown, make it a coefficient curve or slope that either deducts or increases energy based on the last time the plant was watered. This will communicate the effects of overwatering better?
+  - [ ] Auto-watering: unlocks with classmates
+  - [ ] Bulk watering when holding button
+    - Waters everything on 1 plot, not the entire garden
+    - NO bulk harvest or prune.
+  - [x] Make watering required for every stage, else the plant won't evolve.
+    - [x] Timing: only make it available after half of the growth has been filled?
+    - [x] Auto-watering: unlocks for free (right away, or maybe after the next plant has been unlocked) with configurable stage. That means you have likely understood this plant's growth.
+    - Some plants don't need watering to evolve, such as grasses.
+    - [ ] Plants start at negative stage so watering won't give too much energy?
+
+## v0.2: Wet
+
+- [x] Enums
+- [x] Use toJSON() for classes
 
 - [x] Button that skips tutorial for iOS players
-- [ ] Dedicated save file for playtesting
-- [ ] Replace 'view L-system' button with almanac access
+- [x] Dedicated save file for playtesting
 - [x] Rework singular upgrade logic
   - Turn switch plant into regular upgrade
 
-- [ ] Change /sec indicators to /hr (in-game) and display 5x the value
-  - Counter-argument: all parameters display /sec
-
-## v0.2: Education edition
-
-- Calendula
-  - [x] Nerf spread rate to 1/3? Sum equals 1.5 making the pub mult coefficient 2 instead of 1.8
-
 - [x] Explain plant mechanics in Lemma's book: energy, growth
 - [x] Explain symbols without parameters in Ls book
 
@@ -157,8 +263,6 @@ do nothing. Do you feel like it could be more interesting?
     - [x] Add dynamic directions (`m` for min, `M` for max)
   - Spreaded colonies syntax: +1 of Rose campion
   - [x] Propagated colonies inherit the di and dg reserves
-  - [ ] Hey, can you imagine an ash tree propagating a MISTLETOE?
-    - Mistletoe also eats nutrients like hopleek
 
 - [x] Watering
   - Absurd cooldown like 10 minutes (6 days)
@@ -168,11 +272,12 @@ do nothing. Do you feel like it could be more interesting?
   - [x] Extend each species to accomodate for watering change
     - [x] Opportunity to standardise countdown params
   - [x] Lemma book entry
-  - [ ] Auto-watering
-    - Unlocks with classmates
 
 - [x] Colony view params are initially off
-- [ ] Notebook shows next cost
+- [x] Notebook shows next cost
+
+- Calendula
+  - [x] Nerf spread rate to 1/3? Sum equals 1.5 making the pub mult coefficient 2 instead of 1.8
 
 - [x] Basil
   - [x] Signal type 1 kills I?
@@ -229,7 +334,7 @@ displayed on screen
   - [x] If stage lower than first leaf, give the usual intro (move that inside
   the stages object)
 
-## v0: Completed
+## v0: Axiom
 
 - [x] Make at least 2 plants
   - [x] Idleable plant: calendula