diff options
Diffstat (limited to 'docs/main.md')
| -rw-r--r-- | docs/main.md | 65 |
1 files changed, 46 insertions, 19 deletions
diff --git a/docs/main.md b/docs/main.md index 8b6ff1c..b55fa80 100644 --- a/docs/main.md +++ b/docs/main.md @@ -1,23 +1,38 @@ +# design, documentation and notes + +### design: +snub is inspired by [Terrorhedron](https://store.steampowered.com/app/299720/Terrorhedron_Tower_Defense/). <br> +The goal of this project is to expand the Terrorhedron ideas. The main addition are a map editor (even the terrain), a more complex enemy system (topological hierarchy) and more turret upgrades and customization (modules for small bonuses). Mod support and multiplayer are planned. + +--- + ### credits: - voxel-core: https://github.com/ClarkThyLord/Voxel-Core - hdr skies: https://pixeledasteroid.gumroad.com - godot dark theme: https://mounirtohami.itch.io/godot-dark-theme +### legend: +**bold** is done (release quality) <br> +_underline_ is done (debug quality) <br> +regular is planned + ### roadmap: - 0.1 alpha: - turret system - enemy system - - resource system + - resources system - wave system - editor - 0.2 beta: + - unit tests & refactoring - mod api support ### systems: -- turret +- [turret](./turret/turret.md) - _models_ - - *placement* + - _stats_ + - **placement** - _targeting_ - _shooting_ - _economy_ @@ -25,33 +40,45 @@ - modules - range indicator - selection indicator - - _gui info details_ - - *gui shop thumbnail* + - gui + - _info details_ + - **shop thumbnail** + - on select -- enemy: - - *models* - - *path follow* - - *hierarchy* +- [enemy](./enemy/enemy.md): + - **models** + - **path subsystem** + - **hierarchy** - _stats_ - - gui info details - _color change_ - - *hit effect* + - **hit effect** + - gui + - info detail -- resource: - - *Tkads* +- [resources](./resources/resources.md): + - **Tkads** - lives - _economy_ -- wave: +- [wave](./wave/wave.md): - spawns + - randomizer - balance - - gui details - win/lose condition + - gui + - details + - win/lose + - endwave report -- editor: +- [editor](./editor/editor.md): - turret - _attach_ - _path_ - - _voxel cubes_ - - voxel palette - - gui pickers + - voxel + - _cubes_ + - palette + - gui + - picker + - help + - path + - loadsave |