In game design, creation of clear design documentation is incredibly important, even when working as a solo developer. Throughout development of The Last Sprite, I kept detailed design documentation. With so many plates to spin to get the game playing well, sounding great, and looking fantastic, I frequently referenced my design documentation to make sure I was staying on track.
The documentation I created for each mechanic, actor, and tool included some or all of the following (as required):
Description of the mechanic/actor/tool's function and behaviour
The impact it has on the game and player
Associated visuals
Associated sounds
Required exposed variables
Interactions with other mechanics/actors/tools
Reference imagery/video
Example - Grapple Mechanic
I created the following documentation for the creation of grappling mechanic. I used header and bullet point lists to make finding specific information quick and easy.
Description of the mechanic:
Grapple is a player ability
Grapple can only be activated in the air
Activated by holding right click/trigger while in the air while looking at/near a Grapple Point within 2000 units of the player's location
Deactivated by releasing right click/trigger OR on contact with the ground (OnLanding)
While grappled to a Grapple Point, the player swings beneath it
The player can influence the speed and direction of their swing with movement input
Distance between player and Grapple Point should remain constant
When within range of a Grapple Point (2000 units), an icon should appear over the Grapple Point. While the player is on the ground, this icon should indicate that the player needs to jump to be able to grapple. This icon should change when the player is in the air, denoting that the player can now grapple.
Impact on game and player:
Grapple is a platforming tool used to help the player traverse gaps
Using grapple should feel intuitive and satisfying
Grapple helps the player progress through a level
Use of grapple is mandatory
Associated visuals
When activated, a taut vine should appear linking the player to the Grapple Point
Icon that appears over a Grapple Point to indicate grappling is possible.
Icon that appears over a Grapple Point indicating that the player needs to jump to be able to grapple.
See Grapple Point entry for visuals indicating the presence of a Grapple Point
Associated audio
Successfully connecting to a Grapple Point should trigger a whipping sound at the player's location. Sound should go up in pitch.
Successful release of a Grapple Point should trigger a whipping sound at the player's location. Sound should go down in pitch.
Exposed variables
MaxRange (determines how far away the player can initiate grapple)
PlayerSwingInfluence (determines amount of influence player has over swing speed/direction)
Interactions with other mechanics/actors/tools
Grapple Points (grapple connects to these)
Slam, Super Roll, and Jump are disabled while grappling
Grapple is disabled during cutscenes
Additional Reference imagery/video
Comments