diff --git a/docs/entities/ai.rst b/docs/entities/ai.rst new file mode 100644 index 0000000..f42d4b7 --- /dev/null +++ b/docs/entities/ai.rst @@ -0,0 +1,8 @@ +.. _doc_entities_ai: + + +AI +== + + +EntityAI \ No newline at end of file diff --git a/docs/entities/auras.rst b/docs/entities/auras.rst new file mode 100644 index 0000000..57e1a16 --- /dev/null +++ b/docs/entities/auras.rst @@ -0,0 +1,7 @@ +.. _doc_entities_auras: + +Auras +===== + + +AuraData \ No newline at end of file diff --git a/docs/entities/bags.rst b/docs/entities/bags.rst new file mode 100644 index 0000000..a84acf1 --- /dev/null +++ b/docs/entities/bags.rst @@ -0,0 +1,4 @@ +.. _doc_entities_bags: + +Bags +==== \ No newline at end of file diff --git a/docs/entities/crafting.rst b/docs/entities/crafting.rst new file mode 100644 index 0000000..6ad2d1b --- /dev/null +++ b/docs/entities/crafting.rst @@ -0,0 +1,4 @@ +.. _doc_entities_crafting: + +Crafting +======== \ No newline at end of file diff --git a/docs/entities/data.rst b/docs/entities/data.rst new file mode 100644 index 0000000..2f5e855 --- /dev/null +++ b/docs/entities/data.rst @@ -0,0 +1,12 @@ +.. _doc_entities_data: + +Data +==== + + +Data + + +EntityData +EntityClassData + diff --git a/docs/entities/entity.rst b/docs/entities/entity.rst new file mode 100644 index 0000000..84ca632 --- /dev/null +++ b/docs/entities/entity.rst @@ -0,0 +1,26 @@ +.. _doc_entities_entity: + +Entity +====== + +talk about api, how they work + +Entity + +Your main class, base for players, mobs etc + +2d, 3d + + +This should be used fors chests aswell + +bit of a tradeoff +but the waz godot works this is the simplest + +also this way, this is the most extensible system / way it can be done, most general way +most general purpose + +animatable chests, spells that make chests float, applying auras to chests, +casting spells at them etc. + +as apis \ No newline at end of file diff --git a/docs/entities/introduction.rst b/docs/entities/introduction.rst new file mode 100644 index 0000000..28853e5 --- /dev/null +++ b/docs/entities/introduction.rst @@ -0,0 +1,6 @@ +.. _doc_entities_introduction: + +Introduction +============ + + diff --git a/docs/entities/levels.rst b/docs/entities/levels.rst new file mode 100644 index 0000000..2e9fab0 --- /dev/null +++ b/docs/entities/levels.rst @@ -0,0 +1,11 @@ +.. _doc_entities_levels: + +Levels +====== + +how to handle level ups +what needs to be prted + +XPData + +Level Stat Data \ No newline at end of file diff --git a/docs/entities/other.rst b/docs/entities/other.rst new file mode 100644 index 0000000..87dd3fc --- /dev/null +++ b/docs/entities/other.rst @@ -0,0 +1,8 @@ +.. _doc_entities_other: + +Other +===== + + + +diff arrays \ No newline at end of file diff --git a/docs/entities/resources.rst b/docs/entities/resources.rst new file mode 100644 index 0000000..fd18f38 --- /dev/null +++ b/docs/entities/resources.rst @@ -0,0 +1,7 @@ +.. _doc_entities_resources: + +Resources +========= + + +Resources \ No newline at end of file diff --git a/docs/entities/skeleton.rst b/docs/entities/skeleton.rst new file mode 100644 index 0000000..dfde508 --- /dev/null +++ b/docs/entities/skeleton.rst @@ -0,0 +1,10 @@ +.. _doc_entities_skeleton: + +Skeleton +======== + +how they work +design choices +will be ported + +Equipment how to do \ No newline at end of file diff --git a/docs/entities/skills.rst b/docs/entities/skills.rst new file mode 100644 index 0000000..bfb637b --- /dev/null +++ b/docs/entities/skills.rst @@ -0,0 +1,5 @@ +.. _doc_entities_skills: + + +Skills +====== \ No newline at end of file diff --git a/docs/entities/spells.rst b/docs/entities/spells.rst new file mode 100644 index 0000000..ed150f3 --- /dev/null +++ b/docs/entities/spells.rst @@ -0,0 +1,6 @@ +.. _doc_entities_spells: + +Spells +====== + +spells \ No newline at end of file diff --git a/docs/entities/stats.rst b/docs/entities/stats.rst new file mode 100644 index 0000000..17006b6 --- /dev/null +++ b/docs/entities/stats.rst @@ -0,0 +1,9 @@ +.. _doc_entities_stats: + +Stats +===== + +Stats + +Stat +StatModifiers \ No newline at end of file diff --git a/docs/entities/talents.rst b/docs/entities/talents.rst new file mode 100644 index 0000000..e231499 --- /dev/null +++ b/docs/entities/talents.rst @@ -0,0 +1,7 @@ +.. _doc_entities_talents: + +Talents +======= + + +talents \ No newline at end of file diff --git a/docs/faq/procedural_generation.rst b/docs/faq/procedural_generation.rst new file mode 100644 index 0000000..0f24deb --- /dev/null +++ b/docs/faq/procedural_generation.rst @@ -0,0 +1,12 @@ +.. _doc_faq_procedural_generation: + +Procedural generation +===================== + + +How to do procgen + +procgen EntityData +prockeg classdata + +procgen spells diff --git a/docs/general/enums.rst b/docs/general/enums.rst new file mode 100644 index 0000000..0de8800 --- /dev/null +++ b/docs/general/enums.rst @@ -0,0 +1,8 @@ +.. _doc_general_enums: + +Enums +===== + +Big Enums + +Ent ... \ No newline at end of file diff --git a/docs/general/globals.rst b/docs/general/globals.rst new file mode 100644 index 0000000..9efde1d --- /dev/null +++ b/docs/general/globals.rst @@ -0,0 +1,10 @@ +.. _doc_general_globals: + +Globals +======= + +Autoloads + +Tell about them +Data +ProfileManager diff --git a/docs/index.rst b/docs/index.rst index a0e56ae..ffeff75 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,17 +1,12 @@ -.. Entity-Spell System documentation master file, created by - sphinx-quickstart on Thu Dec 26 14:30:34 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to Entity-Spell System's documentation! =============================================== + .. toctree:: :maxdepth: 2 :caption: Contents: - Indices and tables ================== @@ -19,6 +14,91 @@ Indices and tables * :ref:`modindex` * :ref:`search` +.. toctree:: + :maxdepth: 1 + :caption: About + :name: sec-about + + introduction/introduction + introduction/design + introduction/optional_dependencies + introduction/companion_addon + introduction/todos + +.. toctree:: + :maxdepth: 1 + :caption: General + :name: sec-general + + general/globals + general/enums + +.. toctree:: + :maxdepth: 1 + :caption: Entities + :name: sec-entities + + entities/introduction + entities/entity + entities/data + entities/stats + entities/spells + entities/auras + entities/resources + entities/skills + entities/talents + entities/levels + entities/bags + entities/crafting + entities/skeleton + entities/ai + entities/other + +.. toctree:: + :maxdepth: 1 + :caption: Spell and Auras + :name: sec-spells-and-auras + + spells_and_auras/spell + spells_and_auras/aura + spells_and_auras/cooldowns + spells_and_auras/pipelines + spells_and_auras/world_spells + spells_and_auras/spell_visual_effects + +.. toctree:: + :maxdepth: 1 + :caption: Items + :name: sec-items + + items/item + items/craft_recipes + items/equipment + items/item_visuals + items/loot + +.. toctree:: + :maxdepth: 1 + :caption: Profiles + :name: sec-profiles + + profiles/introduction + profiles/profile_manager + profiles/classes + +.. toctree:: + :maxdepth: 1 + :caption: UI + :name: sec-ui + + ui/drag_and_drop + +.. toctree:: + :maxdepth: 1 + :caption: FAQ + :name: sec-faq + + faq/procedural_generation .. toctree:: :maxdepth: 1 @@ -27,7 +107,6 @@ Indices and tables classes/index - .. Indices and tables .. ------------------ .. diff --git a/docs/introduction/companion_addon.rst b/docs/introduction/companion_addon.rst new file mode 100644 index 0000000..6f54d02 --- /dev/null +++ b/docs/introduction/companion_addon.rst @@ -0,0 +1,4 @@ +.. _doc_introduction_companion_addon: + +Companion Addon +=============== \ No newline at end of file diff --git a/docs/introduction/design.rst b/docs/introduction/design.rst new file mode 100644 index 0000000..b542a8e --- /dev/null +++ b/docs/introduction/design.rst @@ -0,0 +1,20 @@ +.. _doc_introduction_design: + + +Design +====== + +Overall design diffp + +scriptabiliy, and expasiveness is key +performance is important aswell + +unfortunately the system is really intettwined, you might need to read the manual more thank once, there is no way +to really separate auras, entities, and spell that much + +Optional dependencies diffp + + +Which are the main classes, what does what etc + +tell about the main classes, and just continue into them \ No newline at end of file diff --git a/docs/introduction/introduction.rst b/docs/introduction/introduction.rst new file mode 100644 index 0000000..b358da5 --- /dev/null +++ b/docs/introduction/introduction.rst @@ -0,0 +1,11 @@ +.. _doc_introduction_introduction: + +Introduction +============ + +What this is + +bigger features +multiplayer + + diff --git a/docs/introduction/optional_dependencies.rst b/docs/introduction/optional_dependencies.rst new file mode 100644 index 0000000..043b1e1 --- /dev/null +++ b/docs/introduction/optional_dependencies.rst @@ -0,0 +1,4 @@ +.. _doc_introduction_optional_dependencies: + +Optional Dependencies +===================== \ No newline at end of file diff --git a/docs/introduction/todos.rst b/docs/introduction/todos.rst new file mode 100644 index 0000000..4e08eff --- /dev/null +++ b/docs/introduction/todos.rst @@ -0,0 +1,18 @@ +.. _doc_introduction_todos: + +Todos +===== + +tell that not yet finished, but really close to it. + +warns will thell about unfisisned things + +todos +link todos + + +Deprecated / Lingering classes + +Untiframe +aiformation + diff --git a/docs/items/craft_recipes.rst b/docs/items/craft_recipes.rst new file mode 100644 index 0000000..c58ed14 --- /dev/null +++ b/docs/items/craft_recipes.rst @@ -0,0 +1,4 @@ +.. _doc_items_craft_recipes: + +Craft Recipes +============= \ No newline at end of file diff --git a/docs/items/equipment.rst b/docs/items/equipment.rst new file mode 100644 index 0000000..26f914c --- /dev/null +++ b/docs/items/equipment.rst @@ -0,0 +1,4 @@ +.. _doc_items_equipment: + +Equipment +========= \ No newline at end of file diff --git a/docs/items/item.rst b/docs/items/item.rst new file mode 100644 index 0000000..735892b --- /dev/null +++ b/docs/items/item.rst @@ -0,0 +1,4 @@ +.. _doc_items_item: + +Item +==== \ No newline at end of file diff --git a/docs/items/item_visuals.rst b/docs/items/item_visuals.rst new file mode 100644 index 0000000..d20701f --- /dev/null +++ b/docs/items/item_visuals.rst @@ -0,0 +1,4 @@ +.. _doc_items_item_visuals: + +Item Visuals +============ \ No newline at end of file diff --git a/docs/items/loot.rst b/docs/items/loot.rst new file mode 100644 index 0000000..22b4d9e --- /dev/null +++ b/docs/items/loot.rst @@ -0,0 +1,8 @@ +.. _doc_items_loot: + +Loot +==== + +Loot +lootdb +will have to change \ No newline at end of file diff --git a/docs/profiles/classes.rst b/docs/profiles/classes.rst new file mode 100644 index 0000000..7c12ca3 --- /dev/null +++ b/docs/profiles/classes.rst @@ -0,0 +1,4 @@ +.. _doc_profiles_classes: + +Classes +======= \ No newline at end of file diff --git a/docs/profiles/introduction.rst b/docs/profiles/introduction.rst new file mode 100644 index 0000000..650527c --- /dev/null +++ b/docs/profiles/introduction.rst @@ -0,0 +1,8 @@ +.. _doc_profiles_introduction: + +Introduction +============ + +Explain profiles + +might be changed \ No newline at end of file diff --git a/docs/profiles/profile_manager.rst b/docs/profiles/profile_manager.rst new file mode 100644 index 0000000..c6608e2 --- /dev/null +++ b/docs/profiles/profile_manager.rst @@ -0,0 +1,6 @@ +.. _doc_profiles_profile_manager: + +Profile Manager +=============== + +=== ProfileManager ==== diff --git a/docs/spells_and_auras/aura.rst b/docs/spells_and_auras/aura.rst new file mode 100644 index 0000000..b994484 --- /dev/null +++ b/docs/spells_and_auras/aura.rst @@ -0,0 +1,6 @@ +.. _doc_spells_and_auras_aura: + +Aura +==== + +Aura diff --git a/docs/spells_and_auras/cooldowns.rst b/docs/spells_and_auras/cooldowns.rst new file mode 100644 index 0000000..25e7d1c --- /dev/null +++ b/docs/spells_and_auras/cooldowns.rst @@ -0,0 +1,7 @@ +.. _doc_spells_and_auras_cooldowns: + +Cooldowns +========= + +Cooldown +Categ Cooldown \ No newline at end of file diff --git a/docs/spells_and_auras/pipelines.rst b/docs/spells_and_auras/pipelines.rst new file mode 100644 index 0000000..da9599d --- /dev/null +++ b/docs/spells_and_auras/pipelines.rst @@ -0,0 +1,7 @@ +.. _doc_spells_and_auras_pipelines: + +Pipelines +========= + +DamageInfo +HealInfo diff --git a/docs/spells_and_auras/spell.rst b/docs/spells_and_auras/spell.rst new file mode 100644 index 0000000..ddb8147 --- /dev/null +++ b/docs/spells_and_auras/spell.rst @@ -0,0 +1,7 @@ +.. _doc_spells_and_auras_spell: + +Spell +===== + +Spell + diff --git a/docs/spells_and_auras/spell_visual_effects.rst b/docs/spells_and_auras/spell_visual_effects.rst new file mode 100644 index 0000000..bcf882e --- /dev/null +++ b/docs/spells_and_auras/spell_visual_effects.rst @@ -0,0 +1,6 @@ +.. _doc_spells_and_auras_spell_visua;_effects: + +Spell Visual Effects +==================== + +Spell Effects (Visuals) diff --git a/docs/spells_and_auras/world_spells.rst b/docs/spells_and_auras/world_spells.rst new file mode 100644 index 0000000..af77af1 --- /dev/null +++ b/docs/spells_and_auras/world_spells.rst @@ -0,0 +1,9 @@ +.. _doc_spells_and_auras_world_spells: + +World Spells +============ + +=== WorldSpells ==== + +todo +what it will do diff --git a/docs/ui/drag_and_drop.rst b/docs/ui/drag_and_drop.rst new file mode 100644 index 0000000..f146e9f --- /dev/null +++ b/docs/ui/drag_and_drop.rst @@ -0,0 +1,8 @@ +.. _doc_ui_srag_and_drop: + +Drag and Drop +============= + +=== UI === + +Drag and drop