Get started with docs cleanup

haihala · Dec 30, 2023 · 9967923 · 9967923
1 parent f4f6193
commit 9967923
Show file tree

Hide file tree

Showing 106 changed files with 165 additions and 195 deletions.
diff --git a/docs/2. Areas/ideas/Idea dump.md b/docs/2. Areas/ideas/Idea dump.md
diff --git a/docs/2. Areas/ideas/Mechanic ideas.md b/docs/2. Areas/ideas/Mechanic ideas.md
diff --git a/docs/2. Areas/spec/genre mechanics/Meter.md b/docs/2. Areas/spec/genre mechanics/Meter.md
diff --git a/docs/2. Areas/spec/interface/Toast.md b/docs/2. Areas/spec/interface/Toast.md
diff --git a/docs/2. Areas/spec/items/Crowbar.md b/docs/2. Areas/spec/items/Crowbar.md
diff --git a/docs/2. Areas/spec/items/Flyweight.md b/docs/2. Areas/spec/items/Flyweight.md
diff --git a/docs/2. Areas/spec/items/Gi.md b/docs/2. Areas/spec/items/Gi.md
diff --git a/docs/2. Areas/spec/items/Kunai.md b/docs/2. Areas/spec/items/Kunai.md
diff --git a/docs/2. Areas/spec/items/Olive oil.md b/docs/2. Areas/spec/items/Olive oil.md
diff --git a/docs/2. Areas/spec/items/Pidgeon wing.md b/docs/2. Areas/spec/items/Pidgeon wing.md
diff --git a/docs/2. Areas/spec/items/Space suit boots.md b/docs/2. Areas/spec/items/Space suit boots.md
diff --git a/docs/2. Areas/spec/unique mechanics/Clash parry.md b/docs/2. Areas/spec/unique mechanics/Clash parry.md
diff --git a/docs/2. Areas/spec/unique mechanics/Money.md b/docs/2. Areas/spec/unique mechanics/Money.md
diff --git a/docs/3. Resources/Bevy/Bevy egui inspector.md b/docs/3. Resources/Bevy/Bevy egui inspector.md
diff --git a/docs/3. Resources/Bevy/Bevy.md b/docs/3. Resources/Bevy/Bevy.md
diff --git a/docs/3. Resources/Cargo.md b/docs/3. Resources/Cargo.md
diff --git a/docs/3. Resources/Obsidian.md b/docs/3. Resources/Obsidian.md
diff --git a/docs/3. Resources/PARA.md b/docs/3. Resources/PARA.md
diff --git a/docs/3. Resources/Reading list.md b/docs/3. Resources/Reading list.md
diff --git a/docs/3. Resources/links.md b/docs/3. Resources/links.md
diff --git a/docs/4. Archive/1. Projects/Bevy 0.12.md b/docs/4. Archive/1. Projects/Bevy 0.12.md
@@ -7,7 +7,7 @@ Interesting picks from [Blog post](https://bevyengine.org/news/bevy-0-12/):
 - https://bevyengine.org/news/bevy-0-12/#improved-hot-reloading-workflow Hot reload is now a cargo feature, just disable it when building for release
 - https://bevyengine.org/news/bevy-0-12/#deferred-rendering + https://bevyengine.org/news/bevy-0-12/#material-extensions
 	- Could allow some stylistic shaders
-	- Could allow to ditch hanabi for a more custom particle system
+	- Could allow to ditch [[bevy_hanabi]] for a more custom particle system
 		- Volumetric vertex shader particles
 - https://bevyengine.org/news/bevy-0-12/#one-shot-systems - Potentially interesting, not sure what for
 	- Events?

diff --git a/docs/4. Archive/1. Projects/Items for playtest.md b/docs/4. Archive/1. Projects/Items for playtest.md
@@ -6,10 +6,10 @@
 	- [x] [[Goalee gear]]
 	- [x] [[Dumbbell]]
 	- [x] [[Can of red paint]]
-	- [x] [[Pack of cigs]]
+	- [x] [[Cigarettes]]
 		- [x] [[Gentleman's pipe]]
 	- [x] [[Feather]]
-		- [x] [[Winged boots]]
+		- [x] [[Feathered boots]]
 	- [x] [[Stopwatch]]
 		- [x] [[Track spikes]]
 	- [x] [[Thumbtacks]]

diff --git a/docs/4. Archive/2. Areas/old areas/core/cancel.md b/docs/4. Archive/2. Areas/old areas/core/cancel.md
@@ -3,4 +3,4 @@
 Many moves can be canceled automatically. See `moves/lib.rs:CancelLevel` for specifics, but in general every action is on a linear track and you can cancel stuff that has a lower cancel level with stuff that has a higher cancel level.
 
 ## Cancel items
-Some [[2. Areas/spec/unique mechanics/Items]]s allow for cancels. Guilty Gear RC and Burst.
+Some [[Items]]s allow for cancels. Guilty Gear RC and Burst.
diff --git a/docs/4. Archive/2. Areas/old areas/core/inputs (old).md b/docs/4. Archive/2. Areas/old areas/core/inputs (old).md
@@ -5,7 +5,7 @@ symbol - mapping on xbox - name
 - `s` - B - Strong attack
 - `g` - Y - Grab
 - `e` - X - Equipment
-	- [[2. Areas/spec/unique mechanics/Items]]
+	- [[Items]]
 
 Concerns for a later date:
 - Dash macro

diff --git a/docs/4. Archive/2. Areas/old areas/core/money (old).md b/docs/4. Archive/2. Areas/old areas/core/money (old).md
@@ -1,6 +1,6 @@
 # Money
 - Resource between rounds.
-- Used to buy [[2. Areas/spec/unique mechanics/Items]]s
+- Used to buy [[Items]]s
 - Gained by
 	- Taunting instead of going for the OKI
 	- Specific items like [[Gauntlet of midas]]

diff --git a/docs/4. Archive/2. Areas/old areas/core/movement.md b/docs/4. Archive/2. Areas/old areas/core/movement.md
@@ -11,4 +11,4 @@ A dash is a commital movement option on the ground. Useful for a fast approach.
 Consists of two parts, the latter of which can be cancelled into jumps for super fast diagonal air approaches or with a move for a sliding move. The only things you really can't do from dash recovery is walk or block.
 
 ## Air dash
-Requires an [[2. Areas/spec/unique mechanics/Items]]. Combined with the double jump [[2. Areas/spec/unique mechanics/Items]] for a downwards air dash [[2. Areas/spec/unique mechanics/Items]]
+Requires an [[Items]]. Combined with the double jump [[Items]] for a downwards air dash [[Items]]
diff --git a/docs/4. Archive/2. Areas/old areas/fluff/philosophy.md b/docs/4. Archive/2. Areas/old areas/fluff/philosophy.md
@@ -20,7 +20,7 @@ This is mostly so I can laugh at how wrong I got them later.
 2. Net positive fun
 	1. Dropping a combo is sad for attacker, neutral for defender, net negative
 3. No problem is without a tool and no tools without a problem
-	1. Tool just needs to exist, the player doesn't need to have it ([[2. Areas/spec/unique mechanics/Items]]s)
+	1. Tool just needs to exist, the player doesn't need to have it ([[Items]]s)
 4. Decision making over execution
 5. Go deep before going wide
 	1. When adding ideas, prefer characters over universals (complex characters over many universals)

diff --git a/docs/3. Resources/Assets.md → docs/external resource reference/Assets.md b/docs/3. Resources/Assets.md → docs/external resource reference/Assets.md
diff --git a/docs/external resource reference/Bevy.md b/docs/external resource reference/Bevy.md
@@ -0,0 +1,26 @@
+[Bevy docs](https://docs.rs/bevy) (Official)
+
+[Bevy cookbook](https://bevy-cheatbook.github.io) (Good, but occasionally outdated)
+
+[[Change detection]]
+
+# Used crates
+- [bevy_hanabi](https://github.com/djeedai/bevy_hanabi)
+- [bevy_scene_hook](https://github.com/nicopap/bevy-scene-hook)
+- [bevy_egui_inspector](https://github.com/jakobhellermann/bevy-inspector-egui)
+
+# Check out
+- [ui_navigation](https://github.com/nicopap/ui-navigation)
+- UI polish
+	- [bevy easings](https://github.com/vleue/bevy_easings "https://github.com/vleue/bevy_easings")
+	- [bevy_tweening](https://github.com/djeedai/bevy_tweening "https://github.com/djeedai/bevy_tweening")
+- [bevy-steamworks](https://github.com/HouraiTeahouse/bevy-steamworks)
+- [bevy_stat_bars](https://github.com/ickshonpe/bevy_stat_bars)
+- [bevy_old_tv_shader](https://github.com/Defernus/bevy_old_tv_shader)
+- For matchmaking hosting: https://railway.app/
+
+## Perhaps
+- [bevy_kira_audio](https://github.com/NiklasEi/bevy_kira_audio)
+- [bevy_asset_loader](https://github.com/NiklasEi/bevy_asset_loader)
+## Hard maybe
+- [autodefault](https://github.com/Lucretiel/autodefault)
diff --git a/docs/3. Resources/Blender is being fucky.md → ...ource reference/Blender is being fucky.md b/docs/3. Resources/Blender is being fucky.md → ...ource reference/Blender is being fucky.md
diff --git a/docs/3. Resources/Rust.md → docs/external resource reference/Rust.md b/docs/3. Resources/Rust.md → docs/external resource reference/Rust.md
diff --git a/docs/2. Areas/playtests/Playtest 1.md → docs/feedback/playtests/Playtest 1.md b/docs/2. Areas/playtests/Playtest 1.md → docs/feedback/playtests/Playtest 1.md
diff --git a/docs/2. Areas/playtests/Playtest 2.md → docs/feedback/playtests/Playtest 2.md b/docs/2. Areas/playtests/Playtest 2.md → docs/feedback/playtests/Playtest 2.md
diff --git a/docs/2. Areas/playtests/Playtest 3.md → docs/feedback/playtests/Playtest 3.md b/docs/2. Areas/playtests/Playtest 3.md → docs/feedback/playtests/Playtest 3.md
diff --git a/...th smart people/Petzku chat 26-01-2022.md → ...th smart people/Petzku chat 26-01-2022.md b/...th smart people/Petzku chat 26-01-2022.md → ...th smart people/Petzku chat 26-01-2022.md
diff --git a/docs/2. Areas/spec/Writing the spec.md → docs/gameplay spec/Writing the spec.md b/docs/2. Areas/spec/Writing the spec.md → docs/gameplay spec/Writing the spec.md
diff --git a/...e/Brainstorming names and concepts.canvas → ...e/Brainstorming names and concepts.canvas b/...e/Brainstorming names and concepts.canvas → ...e/Brainstorming names and concepts.canvas
diff --git a/docs/2. Areas/spec/characters/Mizku.md → docs/gameplay spec/characters/Mizku.md b/docs/2. Areas/spec/characters/Mizku.md → docs/gameplay spec/characters/Mizku.md
@@ -171,7 +171,7 @@ Item ideas:
 
 # Item ideas
 ## Armguards
-- Upgrade from hockey pads (see [[Idea dump#Items]])
+- Upgrade from [[Hockey pads]]
 - One hit of [[Armor]] to [[#Rising sun]]
 
 ## Dancing shoes

diff --git a/docs/2. Areas/spec/flow/Combat.md → docs/gameplay spec/flow/Combat.md b/docs/2. Areas/spec/flow/Combat.md → docs/gameplay spec/flow/Combat.md
diff --git a/docs/2. Areas/spec/flow/Round.md → docs/gameplay spec/flow/Round.md b/docs/2. Areas/spec/flow/Round.md → docs/gameplay spec/flow/Round.md
diff --git a/docs/2. Areas/spec/flow/Shopping.md → docs/gameplay spec/flow/Shopping.md b/docs/2. Areas/spec/flow/Shopping.md → docs/gameplay spec/flow/Shopping.md
@@ -1 +1 @@
-Phase of the game where [[Money]] can be used to buy and sell [[2. Areas/spec/unique mechanics/Items]]
+Phase of the game where [[Money]] can be used to buy and sell [[Items]]
diff --git a/docs/2. Areas/spec/genre mechanics/Armor.md → docs/gameplay spec/genre mechanics/Armor.md b/docs/2. Areas/spec/genre mechanics/Armor.md → docs/gameplay spec/genre mechanics/Armor.md
@@ -1,3 +1,5 @@
 - While you have armor, your attacks can't get interrupted
 - Often just one hit of armor
-- You can be thrown out of armored attacks
+- You can be thrown out of armored attacks
+
+#todo 
diff --git a/docs/gameplay spec/genre mechanics/Gimmick.md b/docs/gameplay spec/genre mechanics/Gimmick.md
@@ -0,0 +1 @@
+Characters have a dedicated button for gimmicks, similar to BlazBlue
diff --git a/docs/2. Areas/spec/genre mechanics/Health.md → docs/gameplay spec/genre mechanics/Health.md b/docs/2. Areas/spec/genre mechanics/Health.md → docs/gameplay spec/genre mechanics/Health.md
diff --git a/docs/2. Areas/spec/genre mechanics/Inputs.md → docs/gameplay spec/genre mechanics/Inputs.md b/docs/2. Areas/spec/genre mechanics/Inputs.md → docs/gameplay spec/genre mechanics/Inputs.md
@@ -37,7 +37,7 @@ The game uses traditional fighter controls with an 8-way joystick and some butto
 		- Speed
 		- Risk-reward
 
-## Gimmick
+## [[Gimmick]]
 - Character based button similar to drive in BlazBlue
-- Often not an attack
+- Not necessarily an attack
 
diff --git a/... Areas/spec/genre mechanics/Intangible.md → ...meplay spec/genre mechanics/Intangible.md b/... Areas/spec/genre mechanics/Intangible.md → ...meplay spec/genre mechanics/Intangible.md
diff --git a/docs/gameplay spec/genre mechanics/Meter.md b/docs/gameplay spec/genre mechanics/Meter.md
@@ -0,0 +1,10 @@
+- Gained from
+	- Playing well
+		- [[Link bonus]]
+		- [[Opener]]
+	- Character unique mechanics
+- Spent on
+	- Enhanced special moves
+	- Items like [[Track spikes]]
+- Turned to money at the end of each round
+- Visualized as a bar of 5 segments, meter is always spent in full segments
diff --git a/docs/gameplay spec/interface/Toast.md b/docs/gameplay spec/interface/Toast.md
@@ -0,0 +1,3 @@
+- Little popups on the side of the screen that inform the player as to what's happening
+
+#todo consider this in [[Notifications 2.0]]
diff --git a/docs/2. Areas/spec/items/Boots.md → docs/gameplay spec/items/basic/Boots.md b/docs/2. Areas/spec/items/Boots.md → docs/gameplay spec/items/basic/Boots.md
diff --git a/docs/2. Areas/spec/items/Can of red paint.md → ...play spec/items/basic/Can of red paint.md b/docs/2. Areas/spec/items/Can of red paint.md → ...play spec/items/basic/Can of red paint.md
diff --git a/docs/2. Areas/spec/items/Pack of cigs.md → docs/gameplay spec/items/basic/Cigarettes.md b/docs/2. Areas/spec/items/Pack of cigs.md → docs/gameplay spec/items/basic/Cigarettes.md
diff --git a/docs/gameplay spec/items/basic/Crowbar.md b/docs/gameplay spec/items/basic/Crowbar.md
@@ -0,0 +1,2 @@
+- Universal basic item
+- Adds more stun frames, damage, and meter gain on the first hit of a combo
diff --git a/docs/2. Areas/spec/items/Dumbbell.md → docs/gameplay spec/items/basic/Dumbbell.md b/docs/2. Areas/spec/items/Dumbbell.md → docs/gameplay spec/items/basic/Dumbbell.md
diff --git a/docs/2. Areas/spec/items/Feather.md → docs/gameplay spec/items/basic/Feather.md b/docs/2. Areas/spec/items/Feather.md → docs/gameplay spec/items/basic/Feather.md
diff --git a/docs/gameplay spec/items/basic/Gi.md b/docs/gameplay spec/items/basic/Gi.md
@@ -0,0 +1,5 @@
+- Universal basic item
+- Gives you a 3S like parry.
+	- Only on the ground and forward for high and low hits
+- "Gi of the old masters"
+	- Simultaneously referring to Daigo and Ken.
diff --git a/docs/2. Areas/spec/items/Hockey pads.md → .../gameplay spec/items/basic/Hockey pads.md b/docs/2. Areas/spec/items/Hockey pads.md → .../gameplay spec/items/basic/Hockey pads.md
diff --git a/docs/gameplay spec/items/basic/Olive oil.md b/docs/gameplay spec/items/basic/Olive oil.md
@@ -0,0 +1,2 @@
+- Universal basic item
+- Lets you apply a small impulse to yourself while getting comboed
diff --git a/docs/2. Areas/spec/items/Stopwatch.md → docs/gameplay spec/items/basic/Stopwatch.md b/docs/2. Areas/spec/items/Stopwatch.md → docs/gameplay spec/items/basic/Stopwatch.md
diff --git a/docs/gameplay spec/items/other/Kunai.md b/docs/gameplay spec/items/other/Kunai.md
@@ -0,0 +1,2 @@
+- Consumable item available for [[Mizku]]
+- Gives access to [[Mizku#Kunai throw]]
diff --git a/docs/2. Areas/spec/items/Pre-workout.md → .../gameplay spec/items/other/Pre-workout.md b/docs/2. Areas/spec/items/Pre-workout.md → .../gameplay spec/items/other/Pre-workout.md
@@ -1,4 +1,4 @@
 - Universal consumable item
 	- Consumed at round start
-- Start the round with a full bar
+- Start the round with [[Meter]] 
 - Cost ineffective, but sometimes it'll let you snowball
diff --git a/docs/2. Areas/spec/items/Thumbtacks.md → docs/gameplay spec/items/other/Thumbtacks.md b/docs/2. Areas/spec/items/Thumbtacks.md → docs/gameplay spec/items/other/Thumbtacks.md
@@ -1,6 +1,6 @@
 - Level 1
 	- Universal basic item
-	- +1 damage to all hits
+	- +1% damage to all hits
 - Level N, N>1
 	- Referred to as [[Thumbtacks]] N
 	- Universal upgrade from two [[Thumbtacks]] N-1

diff --git a/docs/2. Areas/spec/items/Winged boots.md → ...lay spec/items/upgrade/Feathered boots.md b/docs/2. Areas/spec/items/Winged boots.md → ...lay spec/items/upgrade/Feathered boots.md
diff --git a/docs/gameplay spec/items/upgrade/Flyweight.md b/docs/gameplay spec/items/upgrade/Flyweight.md
@@ -0,0 +1,2 @@
+- Universal upgrade of [[Feather]] and [[Dumbbell]]
+- Allows you to tap down for a fast fall.
diff --git a/docs/2. Areas/spec/items/Gentleman's pipe.md → ...ay spec/items/upgrade/Gentleman's pipe.md b/docs/2. Areas/spec/items/Gentleman's pipe.md → ...ay spec/items/upgrade/Gentleman's pipe.md
@@ -1,3 +1,3 @@
-- Upgrade from [[Pack of cigs]] available to: [[Mizku]]
+- Upgrade from [[Cigarettes]] available to: [[Mizku]]
 - [[Intangible]] for [[Mizku#Sway]] startup
 - Name is referencing Slayer
diff --git a/docs/2. Areas/spec/items/Goalee gear.md → ...ameplay spec/items/upgrade/Goalee gear.md b/docs/2. Areas/spec/items/Goalee gear.md → ...ameplay spec/items/upgrade/Goalee gear.md
diff --git a/docs/gameplay spec/items/upgrade/Pidgeon wing.md b/docs/gameplay spec/items/upgrade/Pidgeon wing.md
@@ -0,0 +1,2 @@
+- Universal upgrade from two [[Feather]]s
+- Allows you to double jump
diff --git a/docs/2. Areas/spec/items/Safety boots.md → ...meplay spec/items/upgrade/Safety boots.md b/docs/2. Areas/spec/items/Safety boots.md → ...meplay spec/items/upgrade/Safety boots.md
diff --git a/docs/gameplay spec/items/upgrade/Space suit boots.md b/docs/gameplay spec/items/upgrade/Space suit boots.md
@@ -0,0 +1,2 @@
+- Upgrade from [[Boots]] and a [[Dumbbell]] for [[Mizku]]
+- Makes [[Mizku#Foot dive]] launch on full charge
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Phase of the game where [[Money]] can be used to buy and sell [[2. Areas/spec/unique mechanics/Items]]
		Phase of the game where [[Money]] can be used to buy and sell [[Items]]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Characters have a dedicated button for gimmicks, similar to BlazBlue
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		- Little popups on the side of the screen that inform the player as to what's happening

		#todo consider this in [[Notifications 2.0]]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Universal basic item
		- Adds more stun frames, damage, and meter gain on the first hit of a combo
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Universal basic item
		- Lets you apply a small impulse to yourself while getting comboed
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Consumable item available for [[Mizku]]
		- Gives access to [[Mizku#Kunai throw]]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Universal upgrade of [[Feather]] and [[Dumbbell]]
		- Allows you to tap down for a fast fall.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Universal upgrade from two [[Feather]]s
		- Allows you to double jump
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Upgrade from [[Boots]] and a [[Dumbbell]] for [[Mizku]]
		- Makes [[Mizku#Foot dive]] launch on full charge