Add documentation

main
Bram 2025-08-27 19:50:40 +02:00
parent 4929bc5694
commit a09846bca4
3 changed files with 104 additions and 0 deletions

View File

@ -2,3 +2,7 @@
**Super Tux Brawler** is a brawler game that orients itself around free, open
source and/or public domain fictional characters.
This game is currently in an early development phase, which involves a lot
of character design. You can find more about each character in the
[docs/](docs/) folder.

60
docs/README.md Normal file
View File

@ -0,0 +1,60 @@
# Documentation
This folder hosts documentation about the game and its design.
## Fighters
There are currently ideas floating around for the following characters:
- [Tux](fighters/Tux.md)
## Combat system
Every character has 4 move types. These are:
1. Light attacks
2. Heavy attacks
3. Special attacks
4. Aerial attacks
For every move type, there are four directions that an attack can be made:
1. Up
2. Down
3. Sideways (both left and right)
4. Neutral (no direction)
Some fighters may choose to give more customizability or more options, but
there is a general acceptance that each move type has four different attacks.
A fighter is expected to make the attacks in the given conditions:
| Button type | On ground | In the air |
| -------------- | -------------- | -------------- |
| Light attack | Light attack | Aerial attack |
| Heavy attack | Heavy attack | Aerial attack |
| Special attack | Special attack | Special attack |
## Move types
Although fighters can deviate from the following recommendations, this is
generally a guide for how moves are expected to work:
| Move type | Direction | Description |
| ---------- | --------- | ----------- |
| Light | Up | Defensive move that punishes enemies standing directly above the player, or ones that try to jump over the player. |
| Light | Down | Move with relatively more knockback that pushes enemies back. Should generally miss enemies in the air. |
| Light | Sideways | Standard move that is relatively fast and deals a moderate amount of damage. |
| Light | Neutral | A quick jab or punch that takes very little time and deals little damage. Great for starting combos, or for quickly punishing enemies that react too slowly. |
| Heavy | Up | Slow finisher move that shoots players in the air. |
| Heavy | Down | Usually the quickest and the least effective heavy attack. Does significant damage and knockback but is still somewhat quick. |
| Heavy | Sideways | Slow finisher move with usually the highest knockback. |
| Heavy | Neutral | Usually the slowest move that deals the most damage. Some fighters might be able to hold the button extra long to increase damage buildup. |
| Special | Up | Flight move that suspends the fighter significantly into the air. This is meant for recovery whenever the fighter falls of the arena. |
| Special | Down | Usually a personal special move that helps the fighter gain an advantage in battle. They might charge up some power meter, summon projectiles, activate an ability, create a defensive shield or cause something else to change. |
| Special | Sideways | Usually a personal special move that deals a lot of damage. |
| Special | Neutral | Usually a personal special move that involves firing a projectile. Unless a character is meant to be extremely aggressive and close combat oriented, this move helps the fighter gain the upper hand against an avoidant enemy and keeps the game fun and engaging. |
| Aerial | Up | Usually a defensive move that punishes enemies above the player. |
| Aerial | Down | Usually an offensive move that knocks back enemies downwards. Meant to be quite deadly when there's no ground below. |
| Aerial | Sideways | Usually a standard move that is relatively fast and deals a moderate amount of damage. |
| Aerial | Neutral | Combo-breaking move that hits enemies in (almost) all directions, with the intent of breaking up enemies' flow. |

40
docs/fighters/Tux.md Normal file
View File

@ -0,0 +1,40 @@
# Tux
Tux is a penguin mascot that represents the Linux kernel.
## Base stats
Tux is intended to appear slightly overweight, and therefore Tux is considered
a heavyweight.
## Move design
### Light attacks
### Heavy attacks
Inspired by [this video](https://www.youtube.com/watch?v=GDSpP405O00) of Tux
beating the MSN butterfly in a boxing match, Tux' sideways heavy move should
involve him punching with boxing gloves. The look should be similar to
[King K. Rool's side smash attacks](https://ultimateframedata.com/king_k_rool).
### Special attacks
It seems most fitting that Tux' up special is a jump upwards, after which he
descends quickly and creates a shockwave as he lands. When smashing into the
ground, he should land in his iconic sitting position.
## Alternative skins
### TuxDroid
One skin could be a slightly robotic version of Tux called
[TuxDroid](https://en.wikipedia.org/wiki/Tux_Droid). The slightly robotized
form could be interpreted as glowing CRT-like eyes and a different material
applied to Tux's fur.
### King T.T.T.
Given how King Dedede is sometimes mistaken for the Linux pinguin, it could be
a funny nod to Nintendo's character to dress Tux up in an outfit similar to
King Dedede. (minus the hammer)