summaryrefslogtreecommitdiff
path: root/specs
diff options
context:
space:
mode:
Diffstat (limited to 'specs')
-rw-r--r--specs/00.Introduction.md27
-rw-r--r--specs/01.GameLoopSummary.md50
-rw-r--r--specs/02.Sections.md61
-rw-r--r--specs/03.Mechanics.md80
-rw-r--r--specs/04.GameSetup.md63
-rw-r--r--specs/05.Round.md27
-rw-r--r--specs/06.Demand.md55
-rw-r--r--specs/07.Service.md19
-rw-r--r--specs/08.Items.md19
-rw-r--r--specs/09.UnlocksUpgrades.md19
-rw-r--r--specs/10.HUD.md19
-rw-r--r--specs/build.sh4
12 files changed, 0 insertions, 443 deletions
diff --git a/specs/00.Introduction.md b/specs/00.Introduction.md
deleted file mode 100644
index 9360ec56..00000000
--- a/specs/00.Introduction.md
+++ /dev/null
@@ -1,27 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 metamuffin
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Hurry Curry!
-
-A cooperative fast-paced game about running a restaurant together.
-
-# Alt Names
-- Undercooked
-- Flussigstätte
-- Das Geölterestaurant
-- Counter Strike: Kitchen Offensive
diff --git a/specs/01.GameLoopSummary.md b/specs/01.GameLoopSummary.md
deleted file mode 100644
index e26b61e3..00000000
--- a/specs/01.GameLoopSummary.md
+++ /dev/null
@@ -1,50 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Game Loop Summary
-
-A game starts, you and friends are given basic starting supplies with sufficent amount for a small first day.
-
-Then you go to selecting your opening hours for the first day. Longer opening times means more profit IF it can be met.
-For a first day, it is recommended you stick to a short 11:00 till 15:00 opening hours
-(Each in game hour is 2 minutes irl).
-(Keep in mind the rush hours of 13:00 & 19:00, and the downtime of 15:00)
-Then the first day(round) starts.
-
-During the course of the day, customers will start to come in.
-You & your friends' job is to:
-1. wait for them to decide on an order
-1. take their order
-1. prepare the dish
-1. serve the dish in time
-1. take & clean dirty dishes when they finish
-During the day, there'll be many orders going simultaneously; the challenge is handling them in parallel.
-
-By the end of the day, at closing time, the restaurant will close (ie no longer accept new customers),
-but you'll get an extra hour post closing to finish up the last few orders.
-
-After that 1 hour grace closing period, the day(round) ends, and you'll be meet with a summary sheet of your performance.
-Then you'll be met with the upgrades screen, where you can purchase upgrades & unlock new recipes for your restaurant.
-Then you'll be met with the supply screen, where you'll see how much of each raw items you have in stock, and where you can buy extra for tomorrow(next round).
-(Keep in mind, that any net profits will be taxed 10% by the goverment. In case of no net profit (or loss), there'll be no tax.)
-
-Rinse & repeat.
-But starting from day 2, before you decide when to open,
-there'll be a summary screen of the previous day's(round's) customer's arrival times.
-(expect today's rush & peak hours and number of customer to not be too drastically different from yesterday.)
-
-Goodluck Cooking!
diff --git a/specs/02.Sections.md b/specs/02.Sections.md
deleted file mode 100644
index fd9dde17..00000000
--- a/specs/02.Sections.md
+++ /dev/null
@@ -1,61 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Sections
-
-### 00. Introduction
-Short summary of how the game works from the player's prespective.
-
-### 01. Game Loop Summary
-Short summary of how the game works from the player's prespective.
-
-### 02. Sections
-Short summary of the different sections of this design document. (You are here)
-
-### 03. Mechanics
-Short summary of each of the different mechanics of the game.
-
-### 04. Game Setup
-Intial game setup at the start of a new game.
-
-### 05. Game Loop (!TODO)
-The game loop of the game.
-
-### 05.a. Pre Round (!TODO)
-Everything that happens before opening.
-
-### 05.b. Round (!TODO)
-Everything that happens during a day.
-
-### 05.c. Post Round (!TODO)
-Everything that happens after closing.
-
-### 06. Demand
-Details of the computation of the customers' group traffic & size and demand scaling.
-
-### 07. Service (!TODO)
-Details of how customers behave.
-
-### 08. Items (!TODO)
-Details of all items: raw, meals, inbetweens, & their pipelines with flow graphs.
-
-### 09. Unlocks/Upgrades (!TODO)
-Details of all the stuff that is locked and can be unlocked during the course of a game.
-
-### 10. HUD (!TODO)
-Visual elements of the screen.
-
diff --git a/specs/03.Mechanics.md b/specs/03.Mechanics.md
deleted file mode 100644
index 0aa6820b..00000000
--- a/specs/03.Mechanics.md
+++ /dev/null
@@ -1,80 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Mechanics
-
-## 01. Grid
-The restaurant(game area) is split into grid cells called tiles.
-A tile may be walkable if it has no furniture or appliances.
-
-## 02. Items
-An item is anything that can be carried by the player.
-Such items include plates, meals(eg burger), and raw foods(eg flour).
-Only one item may be carried at a time.
-
-## 03. Recipes
-Recipes are how items can be made into other items alone or by combining.
-Some recipes take raw foods(eg tomatoes->sliced tomatoes), but not all(eg dough->bread).
-Some result in servicable meals(eg bread + cooked steak -> burger), but not all(eg flour->dough).
-Some combine instantly(eg sliced tomatoes + plate -> tomato meal),
-but some require waiting(eg dough->bread in oven),
-others require active cooking(by holding down the action button for some duration)(eg flour->dough).
-
-## 04. Clock
-Usual opening hours 12:00-22:00 (10 hours) last 20 irl minutes.
-This can be shortened or elongated (min 1 hour, max 24 hours from 00:00 to 24:00).
-Not all opening times are equal, some will result in more or fewer customers.
-But even when they'll result in more or less customers will shift from day to day.
-But consecutive days will usually result in similar traffic graphs.
-
-## 05. Active/Passive Time Sink Actions
-As stated [above](#03-recipes), some actions will not be instant.
-As an example, kneading flour into dough will require the player to hold down the action button for 5 seconds.
-But some are done passively, for example, baking dough into bread requires the player to put the dough into the oven, it will then start to be bake, and the player can return in 20 seconds to grab their baked bread.
-
-## 06. Customers
-Customers come during opening hours, usually alone or in groups of 2.
-Customers will find a seat, and then will usually take 0:20 (ie 10 seconds) to decide what to order.
-Customers will always order 1 meal, once they decided on their order, most will only wait for their order to be fuffilled in 0:40 (ie 20 seconds).
-If not serviced in 0:40, they'll get angry, leave and decrease your star rating. (also they won't pay; also the entire group will leave)
-If serviced, you'll get money from 1€ to 10€.
-If the entire group is serviced, you'll also increase your star rating, and they'll leave leaving dirty dishes behind, making room for other customers.
-
-## 07. Money
-Money is in €, it is gained by fuffiling orders.
-It can be used to buy raw supplies and unlocks.
-
-## 08. Raw Supply
-Can be ordered for the next day after closing and finishing off a day.
-Each raw item has a seperate expiry duration,
-some are short(eg steak must be used in 2 days),
-some are essentially infinite(eg water has a duration of 1000 days).
-When used during the day, items closer to the expiry date are used first.
-
-## 09. Star Rating
-Goes from 0 stars to 5.
-Gained by fuffiling orders of an entire customer table (+0.03 stars).
-Lost by not doing so (-0.12 stars).
-Does nothing.
-
-## 10. Unlocks/Upgrades
-Not all items, raw supplies, & recipes are unlocked at the start of the game.
-But they can be purchased at the end of a day.
-When an unlock(eg bread) is purchased,
-all of its assoicated items(ie flour, dough, & bread),
-raw item supplies(ie flour supply),
-and recipes(ie flour->dough and dough->bread, and if steak is also unlocked then eg burger will also be unlocked).
diff --git a/specs/04.GameSetup.md b/specs/04.GameSetup.md
deleted file mode 100644
index 250e3994..00000000
--- a/specs/04.GameSetup.md
+++ /dev/null
@@ -1,63 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Game Setup
-
-## Restaurant
-The game intially starts with 0€, and only tomatoes unlocked.
-You start out with an intial supply of 10 tomatoes in the tomato bag.
-
-With the restaurant in this form
-```
-+--------------------+
-|ctc.ctc.ctc.ctc.ctc.|
-|.....c..............|
-|c...c...+--www---dd-+
-|tc.ctc..|##...##W..#|
-|c...c...w..........S|
-|c.......w..######..T|
-|tc......w..........F|
-|c.....ct|##ss##ooo##|
-+---dd---+-----------+
-```
-
-- `.`: nothing
-- `+`,`-`,`|` : walls
-- `d`: door
-- `t`: table
-- `c`: chair
-- `#`: counter
-- `w`: counter(window)
-- `s`: sink
-- `o`: oven
-- `W`: watercooler
-- `S`: [steak] freezer
-- `T`: tomoto bag
-- `F`: flour bag
-
-
-## Demand
-Check the [Demand section](06.Demand.md) for more info on what this means.
-
-Demand scale starts at 0%.
-(from -50% to +50%)
-
-Demand graph starts at offset 9 hours.
-$$\sin\left(3\sin\frac{\left(hour+offset\right)}{2}\right)+1$$
-```c
-demand = sin(3*sin((hour+offset)/2))+1
-```
diff --git a/specs/05.Round.md b/specs/05.Round.md
deleted file mode 100644
index 02d39592..00000000
--- a/specs/05.Round.md
+++ /dev/null
@@ -1,27 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Pre Round
-!TODO
-
-# Round
-!TODO
-
-# Post Round
-!TODO
-
-
diff --git a/specs/06.Demand.md b/specs/06.Demand.md
deleted file mode 100644
index b42348a2..00000000
--- a/specs/06.Demand.md
+++ /dev/null
@@ -1,55 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Demand
-
-Every tick(?TODO: specify further), a probability is sampled from [the demand equation](#the-demand-equation),
-that number is then multiplied by the [traffic coefficent](#traffic-coefficent),
-that number is then multiplied by the [demand bias](#the-demand-bias),
-that will give a probability on whether a customer will be spawned on this tick.
-
-### The Demand Equation
-$$\sin\left(3\sin\frac{\left(hour+offset\right)}{2}\right)+1$$
-```c
-demand = sin(3*sin((hour+offset)/2))+1
-```
-(always nonnegative below 2)
-
-every day the `offset` will be offset by `[-1,1]` multiplied by the [sway coefficent](#sway-coefficent).
-```c
-offset += rand(-1,1) * sway
-```
-
-### The Demand Bias
-Demand scale starts at 0%.
-(from -50% to +50%)
-
-every day the `bias` will be offset by `[-10,10]` multiplied by the [sway coefficent](#sway-coefficent).
-(clamped to -50% & 50%).
-```c
-bias += rand(-10,10) * sway
-bias = clamp(bias,-50,50)
-```
-
-### Traffic Coefficent
-Usually 1%
-can be changed by the host.
-
-### Sway Coefficent
-Usually 50%
-can be changed by the host.
-
diff --git a/specs/07.Service.md b/specs/07.Service.md
deleted file mode 100644
index 6c388aa6..00000000
--- a/specs/07.Service.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Service
-!TODO
diff --git a/specs/08.Items.md b/specs/08.Items.md
deleted file mode 100644
index 1e3590ee..00000000
--- a/specs/08.Items.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Items
-!TODO
diff --git a/specs/09.UnlocksUpgrades.md b/specs/09.UnlocksUpgrades.md
deleted file mode 100644
index 5e512e7f..00000000
--- a/specs/09.UnlocksUpgrades.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# Unlocks/Upgrades
-!TODO
diff --git a/specs/10.HUD.md b/specs/10.HUD.md
deleted file mode 100644
index f48d3814..00000000
--- a/specs/10.HUD.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
- Hurry Curry! - a game about cooking
- Copyright 2024 Sofviic
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, version 3 of the License only.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
--->
-# HUD
-!TODO
diff --git a/specs/build.sh b/specs/build.sh
deleted file mode 100644
index 9ffd1f93..00000000
--- a/specs/build.sh
+++ /dev/null
@@ -1,4 +0,0 @@
-#! bin/bash
-
-rm specs/specs_book.html
-pandoc --webtex specs/*.md > specs/specs_book.html