---
# System prepended metadata

title: Detox Technical Design Document
tags: [Detox]

---

# Detox Technical Design Document
## Naming Conventions
* Variables: camelCase, i.e.,`bool readyPlayerOne;`
* Functions: PascelCase, i.e., `void Start();`
* Classes: PascelCase `class Menu`
* Folder/File names: PascelCase, i.e., `AnimatorControllers`; `PlayerPrefab`
* Art Asset names: PascalCase with Initials, i.e., `Tall_Bush_SK`
## File Structure
TBD
## File Formats and Specifications
* Animations
    * File format: .Anim
* Models
    * File format: .FBX
* Scripts
    * Language: C#
    * File format: .cs
* Sounds
    * File format: .wav
* Sprites
    * File format: .png
## Tools
* Target platform: PC
* Game Engine: Unity
* Third party assets and tools TBD
## Architecture
* Major Gameplay Systems
    * Melee and Ranged combat
    * Inventory and crafting
    * Purifying corrupted life
    * Questing
    * Leveling and stat system
* Backend Systems
    * TBD
* Gamestates/Flow
    * Main Menu State
    * Game State
    * Credits State
    * Others TBD
## Technicals Risks
* Two person team
* Being funded by outside source
###### Tags: `Detox`