Skeleton for the docs. In some cases I also added some quick notes.

This commit is contained in:
Relintai 2019-12-27 01:00:47 +01:00
parent 453280f6c3
commit 2565a4bcc9
39 changed files with 395 additions and 7 deletions

8
docs/entities/ai.rst Normal file
View File

@ -0,0 +1,8 @@
.. _doc_entities_ai:
AI
==
EntityAI

7
docs/entities/auras.rst Normal file
View File

@ -0,0 +1,7 @@
.. _doc_entities_auras:
Auras
=====
AuraData

4
docs/entities/bags.rst Normal file
View File

@ -0,0 +1,4 @@
.. _doc_entities_bags:
Bags
====

View File

@ -0,0 +1,4 @@
.. _doc_entities_crafting:
Crafting
========

12
docs/entities/data.rst Normal file
View File

@ -0,0 +1,12 @@
.. _doc_entities_data:
Data
====
Data
EntityData
EntityClassData

26
docs/entities/entity.rst Normal file
View File

@ -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

View File

@ -0,0 +1,6 @@
.. _doc_entities_introduction:
Introduction
============

11
docs/entities/levels.rst Normal file
View File

@ -0,0 +1,11 @@
.. _doc_entities_levels:
Levels
======
how to handle level ups
what needs to be prted
XPData
Level Stat Data

8
docs/entities/other.rst Normal file
View File

@ -0,0 +1,8 @@
.. _doc_entities_other:
Other
=====
diff arrays

View File

@ -0,0 +1,7 @@
.. _doc_entities_resources:
Resources
=========
Resources

View File

@ -0,0 +1,10 @@
.. _doc_entities_skeleton:
Skeleton
========
how they work
design choices
will be ported
Equipment how to do

5
docs/entities/skills.rst Normal file
View File

@ -0,0 +1,5 @@
.. _doc_entities_skills:
Skills
======

6
docs/entities/spells.rst Normal file
View File

@ -0,0 +1,6 @@
.. _doc_entities_spells:
Spells
======
spells

9
docs/entities/stats.rst Normal file
View File

@ -0,0 +1,9 @@
.. _doc_entities_stats:
Stats
=====
Stats
Stat
StatModifiers

View File

@ -0,0 +1,7 @@
.. _doc_entities_talents:
Talents
=======
talents

View File

@ -0,0 +1,12 @@
.. _doc_faq_procedural_generation:
Procedural generation
=====================
How to do procgen
procgen EntityData
prockeg classdata
procgen spells

8
docs/general/enums.rst Normal file
View File

@ -0,0 +1,8 @@
.. _doc_general_enums:
Enums
=====
Big Enums
Ent ...

10
docs/general/globals.rst Normal file
View File

@ -0,0 +1,10 @@
.. _doc_general_globals:
Globals
=======
Autoloads
Tell about them
Data
ProfileManager

View File

@ -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
.. ------------------
..

View File

@ -0,0 +1,4 @@
.. _doc_introduction_companion_addon:
Companion Addon
===============

View File

@ -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

View File

@ -0,0 +1,11 @@
.. _doc_introduction_introduction:
Introduction
============
What this is
bigger features
multiplayer

View File

@ -0,0 +1,4 @@
.. _doc_introduction_optional_dependencies:
Optional Dependencies
=====================

View File

@ -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

View File

@ -0,0 +1,4 @@
.. _doc_items_craft_recipes:
Craft Recipes
=============

4
docs/items/equipment.rst Normal file
View File

@ -0,0 +1,4 @@
.. _doc_items_equipment:
Equipment
=========

4
docs/items/item.rst Normal file
View File

@ -0,0 +1,4 @@
.. _doc_items_item:
Item
====

View File

@ -0,0 +1,4 @@
.. _doc_items_item_visuals:
Item Visuals
============

8
docs/items/loot.rst Normal file
View File

@ -0,0 +1,8 @@
.. _doc_items_loot:
Loot
====
Loot
lootdb
will have to change

View File

@ -0,0 +1,4 @@
.. _doc_profiles_classes:
Classes
=======

View File

@ -0,0 +1,8 @@
.. _doc_profiles_introduction:
Introduction
============
Explain profiles
might be changed

View File

@ -0,0 +1,6 @@
.. _doc_profiles_profile_manager:
Profile Manager
===============
=== ProfileManager ====

View File

@ -0,0 +1,6 @@
.. _doc_spells_and_auras_aura:
Aura
====
Aura

View File

@ -0,0 +1,7 @@
.. _doc_spells_and_auras_cooldowns:
Cooldowns
=========
Cooldown
Categ Cooldown

View File

@ -0,0 +1,7 @@
.. _doc_spells_and_auras_pipelines:
Pipelines
=========
DamageInfo
HealInfo

View File

@ -0,0 +1,7 @@
.. _doc_spells_and_auras_spell:
Spell
=====
Spell

View File

@ -0,0 +1,6 @@
.. _doc_spells_and_auras_spell_visua;_effects:
Spell Visual Effects
====================
Spell Effects (Visuals)

View File

@ -0,0 +1,9 @@
.. _doc_spells_and_auras_world_spells:
World Spells
============
=== WorldSpells ====
todo
what it will do

View File

@ -0,0 +1,8 @@
.. _doc_ui_srag_and_drop:
Drag and Drop
=============
=== UI ===
Drag and drop