From cc4c5edc91ff1eb0573712563796edcf248c45a3 Mon Sep 17 00:00:00 2001 From: Relintai Date: Fri, 10 Apr 2020 15:56:38 +0200 Subject: [PATCH] Removed sphinx based docs, as a better readme.md should be enough. --- docs/.gitignore | 26 -- docs/Makefile | 20 -- docs/_static/css/custom.css | 273 ------------------ docs/_templates/breadcrumbs.html | 7 - docs/_templates/layout.html | 4 - docs/classes/index.rst | 9 - docs/conf.py | 117 -------- docs/create_class_docs.sh | 2 - docs/entities/ai.rst | 8 - docs/entities/auras.rst | 7 - docs/entities/bags.rst | 46 --- docs/entities/crafting.rst | 19 -- docs/entities/data.rst | 12 - docs/entities/entity.rst | 26 -- docs/entities/introduction.rst | 6 - docs/entities/levels.rst | 11 - docs/entities/networking.rst | 10 - docs/entities/other.rst | 8 - docs/entities/pets.rst | 18 -- docs/entities/resources.rst | 7 - docs/entities/skeleton.rst | 10 - docs/entities/skills.rst | 5 - docs/entities/spells.rst | 6 - docs/entities/stats.rst | 9 - docs/entities/talents.rst | 7 - docs/extensions/gdscript.py | 176 ----------- docs/faq/procedural_generation.rst | 12 - docs/general/enums/entity_enums.rst | 152 ---------- docs/general/enums/index.rst | 20 -- docs/general/enums/item_enums.rst | 59 ---- docs/general/enums/spell_enums.rst | 56 ---- docs/general/globals/entity_data_manager.rst | 38 --- docs/general/globals/globals.rst | 23 -- docs/general/globals/profile_manager.rst | 17 -- docs/index.rst | 109 ------- docs/introduction/companion_addon.rst | 14 - docs/introduction/compiling.rst | 23 -- docs/introduction/design.rst | 20 -- docs/introduction/introduction.rst | 16 - docs/introduction/optional_dependencies.rst | 4 - docs/introduction/todos.rst | 18 -- docs/items/craft_recipes.rst | 4 - docs/items/equipment.rst | 4 - docs/items/item.rst | 4 - docs/items/item_visuals.rst | 4 - docs/items/loot.rst | 8 - docs/make.bat | 35 --- docs/spells_and_auras/aura.rst | 6 - docs/spells_and_auras/cooldowns.rst | 18 -- docs/spells_and_auras/pipelines.rst | 7 - docs/spells_and_auras/spell.rst | 8 - .../spells_and_auras/spell_visual_effects.rst | 6 - docs/spells_and_auras/world_spells.rst | 9 - docs/ui/drag_and_drop.rst | 15 - 54 files changed, 1558 deletions(-) delete mode 100644 docs/.gitignore delete mode 100644 docs/Makefile delete mode 100644 docs/_static/css/custom.css delete mode 100644 docs/_templates/breadcrumbs.html delete mode 100644 docs/_templates/layout.html delete mode 100644 docs/classes/index.rst delete mode 100644 docs/conf.py delete mode 100755 docs/create_class_docs.sh delete mode 100644 docs/entities/ai.rst delete mode 100644 docs/entities/auras.rst delete mode 100644 docs/entities/bags.rst delete mode 100644 docs/entities/crafting.rst delete mode 100644 docs/entities/data.rst delete mode 100644 docs/entities/entity.rst delete mode 100644 docs/entities/introduction.rst delete mode 100644 docs/entities/levels.rst delete mode 100644 docs/entities/networking.rst delete mode 100644 docs/entities/other.rst delete mode 100644 docs/entities/pets.rst delete mode 100644 docs/entities/resources.rst delete mode 100644 docs/entities/skeleton.rst delete mode 100644 docs/entities/skills.rst delete mode 100644 docs/entities/spells.rst delete mode 100644 docs/entities/stats.rst delete mode 100644 docs/entities/talents.rst delete mode 100644 docs/extensions/gdscript.py delete mode 100644 docs/faq/procedural_generation.rst delete mode 100644 docs/general/enums/entity_enums.rst delete mode 100644 docs/general/enums/index.rst delete mode 100644 docs/general/enums/item_enums.rst delete mode 100644 docs/general/enums/spell_enums.rst delete mode 100644 docs/general/globals/entity_data_manager.rst delete mode 100644 docs/general/globals/globals.rst delete mode 100644 docs/general/globals/profile_manager.rst delete mode 100644 docs/index.rst delete mode 100644 docs/introduction/companion_addon.rst delete mode 100644 docs/introduction/compiling.rst delete mode 100644 docs/introduction/design.rst delete mode 100644 docs/introduction/introduction.rst delete mode 100644 docs/introduction/optional_dependencies.rst delete mode 100644 docs/introduction/todos.rst delete mode 100644 docs/items/craft_recipes.rst delete mode 100644 docs/items/equipment.rst delete mode 100644 docs/items/item.rst delete mode 100644 docs/items/item_visuals.rst delete mode 100644 docs/items/loot.rst delete mode 100644 docs/make.bat delete mode 100644 docs/spells_and_auras/aura.rst delete mode 100644 docs/spells_and_auras/cooldowns.rst delete mode 100644 docs/spells_and_auras/pipelines.rst delete mode 100644 docs/spells_and_auras/spell.rst delete mode 100644 docs/spells_and_auras/spell_visual_effects.rst delete mode 100644 docs/spells_and_auras/world_spells.rst delete mode 100644 docs/ui/drag_and_drop.rst diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 7f5c973..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,26 +0,0 @@ -_build/ -env/ - -classes/* -!classes/index.rst - -__pycache__ -*.pyc -*~ -.directory -.vs/ -.vscode/ -*.mo - -*.swo -*.swp - -.DS_Store -[Tt]humbs.db -[Tt]humbs.db:encryptable -ehthumbs.db -ehthumbs_vista.db - -__MACOSX -*.lnk -[Dd]esktop.ini diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index dcee282..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -j auto -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css deleted file mode 100644 index d7f65eb..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,273 +0,0 @@ -/** - * Various tweaks to the Read the Docs theme to better conform with Godot's visual identity. - */ - - :root { - --navbar-background-color: #292c37; - --navbar-background-color-hover: #292c37; - --navbar-background-color-active: #212d51; - --navbar-current-background-color: #000; - --navbar-current-background-color-hover: #1c1f26; - --navbar-current-background-color-active: #131e3b; - --navbar-level-1-color: #fff; - --navbar-level-2-color: #f0f8ff; - --navbar-level-3-color: #ddcd8d; - --navbar-heading-color: #d7bd6f; - --link-color-active: #105078; - --code-literal-color: #d04c60; - --highlight-background-color: #f5ffe1; - --input-background-color: #fcfcfc; - --input-focus-border-color: #5f8cff; -} - -body, -h1, -h2, -h3, -h4, -h5, -h6, -input[type="text"], -input[type="button"], -input[type="reset"], -input[type="submit"], -textarea, -legend, -.btn, -.rst-content .toctree-wrapper p.caption, -.rst-versions { - /* Use a system font stack for better performance (no Web fonts required) */ - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; -} - -h1, -h2, -h3, -h4, -h5, -h6, -legend, -.rst-content .toctree-wrapper p.caption { - /* Use a lighter font for headers (Medium instead of Bold) */ - font-weight: 500; -} - -p, -article ul, -article ol, -.wy-plain-list-disc, -.wy-plain-list-decimal, -.rst-content ol.arabic, -.rst-content .section ul, -.rst-content .toctree-wrapper ul, -.rst-content .section ol { - /* Increase the line height slightly to account for the different font */ - line-height: 25px; -} - -a:hover { - text-decoration: underline; -} - -a:active { - /* Add visual feedback when clicking on a link */ - color: var(--link-color-active); -} - -a.btn:hover { - text-decoration: none; -} - -/* Code display tweaks */ - -code, -.rst-content tt, -.rst-content code { - font-size: 14px; -} - -.rst-content tt.literal, -.rst-content code.literal { - color: var(--code-literal-color); -} - -.rst-content pre.literal-block, -.rst-content div[class^="highlight"] pre, -.rst-content .linenodiv pre { - /* Increase the font size and line height in code blocks */ - font-size: 14px; - line-height: 1.5; -} - -.highlight { - background-color: var(--highlight-background-color); -} - -/* Navigation bar logo and search */ - -.wy-side-nav-search { - background-color: var(--navbar-background-color); -} - -.wy-side-nav-search > a:hover, -.wy-side-nav-search .wy-dropdown > a:hover { - background-color: var(--navbar-background-color-hover); -} - -.wy-side-nav-search > a:active, -.wy-side-nav-search .wy-dropdown > a:active { - background-color: var(--navbar-background-color-active); -} - -.wy-side-nav-search input[type="text"] { - background-color: var(--input-background-color); - /* Avoid reflowing when toggling the focus state */ - border: 2px solid transparent; - box-shadow: none; - /* Make visual feedback instant */ - transition: none; - font-size: 14px; -} - -.wy-side-nav-search input[type="text"]:focus { - border: 2px solid var(--input-focus-border-color); -} - -/* Navigation bar */ - -.wy-nav-side { - background-color: var(--navbar-background-color); -} - -.wy-menu-vertical header, -.wy-menu-vertical p.caption { - color: var(--navbar-heading-color); - - /* Improves the appearance of uppercase text */ - letter-spacing: 0.75px; -} - -/* Mobile navigation */ - -.wy-nav-top, -.wy-nav-top a { - background-color: var(--navbar-background-color); - color: var(--navbar-level-1-color); -} - -/* Version branch label below the logo */ -.wy-side-nav-search > div.version { - color: var(--navbar-level-3-color); - opacity: 0.9; -} - -/* First level of navigation items */ - -.wy-menu-vertical { - /* Account for the increased `toctree-expand` button margins */ - width: 308px; -} - -.wy-menu-vertical a { - color: var(--navbar-level-1-color); -} - -.wy-menu-vertical a:hover { - background-color: var(--navbar-background-color-hover); - color: var(--navbar-level-1-color); -} - -.wy-menu-vertical a:active { - background-color: var(--navbar-background-color-active); -} - -.wy-menu-vertical li.toctree-l1.current > a { - border: none; -} - -.wy-side-nav-search, .wy-menu-vertical a, .wy-menu-vertical a span.toctree-expand, -.wy-menu-vertical li.toctree-l2 a span.toctree-expand { - color: var(--navbar-level-3-color); - opacity: 0.9; - margin-right: 8px; -} - -.wy-side-nav-search, .wy-menu-vertical a, .wy-menu-vertical a:hover span.toctree-expand, -.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand { - color: var(--navbar-level-2-color); - opacity: 1; -} - -.wy-side-nav-search, .wy-menu-vertical a, .wy-menu-vertical a:active span.toctree-expand, -.wy-menu-vertical li.toctree-l2 a:active span.toctree-expand { - color: var(--navbar-level-1-color); - opacity: 1; -} - -/* Second (and higher) levels of navigation items */ - -.wy-menu-vertical li.current a, -.wy-menu-vertical li.toctree-l2.current > a, -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a, -.wy-menu-vertical li.toctree-l2.current li.toctree-l4 > a { - background-color: var(--navbar-current-background-color); - color: var(--navbar-level-2-color); -} - -.wy-menu-vertical li.current a:hover, -.wy-menu-vertical li.toctree-l2.current > a:hover, -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover, -.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a:hover { - background-color: var(--navbar-current-background-color-hover); -} - -.wy-menu-vertical li.current a:active, -.wy-menu-vertical li.toctree-l2.current > a:active, -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:active, -.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a:active { - background-color: var(--navbar-current-background-color-active); -} - -/* Version selector (only visible on Read the Docs) */ - -.rst-versions { - background-color: var(--navbar-current-background-color); -} - -.rst-versions a, -.rst-versions .rst-current-version, -.rst-versions .rst-current-version .fa, -.rst-versions .rst-other-versions dd a { - color: var(--navbar-level-1-color); -} - -.rst-versions .rst-other-versions small { - color: var(--navbar-level-3-color); -} - -.rst-versions .rst-other-versions dd a:hover { - text-decoration: underline; -} - -.rst-versions .rst-other-versions { - color: var(--navbar-heading-color); -} - -.rst-versions .rst-current-version { - background-color: var(--navbar-current-background-color); -} - -.rst-versions .rst-current-version:hover { - background-color: var(--navbar-current-background-color-hover); -} - -.rst-versions .rst-current-version:active { - background-color: var(--navbar-current-background-color-active); -} - -/* Hide the obnoxious automatic highlight in search results */ -.rst-content .highlighted { - background-color: transparent; - font-weight: inherit; - padding: 0; -} diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html deleted file mode 100644 index 804ad69..0000000 --- a/docs/_templates/breadcrumbs.html +++ /dev/null @@ -1,7 +0,0 @@ -{%- extends "sphinx_rtd_theme/breadcrumbs.html" %} - -{% block breadcrumbs_aside %} -{% if not meta or meta.get('github_url') != 'hide' %} -{{ super() }} -{% endif %} -{% endblock %} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html deleted file mode 100644 index e0125e6..0000000 --- a/docs/_templates/layout.html +++ /dev/null @@ -1,4 +0,0 @@ -{% extends "!layout.html" %} -{% block linktags %} - {{ super() }} -{% endblock %} diff --git a/docs/classes/index.rst b/docs/classes/index.rst deleted file mode 100644 index c6001e4..0000000 --- a/docs/classes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Entity Spell System API -======================= - -.. toctree:: - :maxdepth: 1 - :name: toc-class-ref - :glob: - - class_* diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 553b4b8..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,117 +0,0 @@ -# -*- coding: utf-8 -*- -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys -# sys.path.insert(0, os.path.abspath('.')) - -needs_sphinx = '1.3' - - -# -- Project information ----------------------------------------------------- - -project = 'Entity Spell System for GODOT' -copyright = '2019-2020, Péter Magyar (Relintai)' -author = 'Péter Magyar (Relintai)' - -version = 'latest' -release = 'latest' - -# Parse Sphinx tags passed from RTD via environment -env_tags = os.getenv('SPHINX_TAGS') -if env_tags != None: - for tag in env_tags.split(','): - print("Adding Sphinx tag: %s" % tag.strip()) - tags.add(tag.strip()) - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -sys.path.append(os.path.abspath('extensions')) -extensions = [ - 'gdscript', 'sphinx.ext.imgmath' -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -source_suffix = '.rst' -source_encoding = 'utf-8-sig' - -# GDScript syntax highlighting -from gdscript import GDScriptLexer -from sphinx.highlighting import lexers -lexers['gdscript'] = GDScriptLexer() - -# Pygments (syntax highlighting) style to use -pygments_style = 'sphinx' -highlight_language = 'gdscript' - -# -- Options for HTML output ------------------------------------------------- - -# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' - -import sphinx_rtd_theme -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -if on_rtd: - using_rtd_theme = True - -# Theme options -html_theme_options = { - # 'typekit_id': 'hiw1hhg', - # 'analytics_id': '', - # 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling. - 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text - 'collapse_navigation': False, # Collapse navigation (False makes it tree-like) - # 'display_version': True, # Display the docs version - # 'navigation_depth': 4, # Depth of the headers shown in the navigation bar -} - -# VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github -html_context = { - "display_github": True, # Integrate GitHub - "github_user": "Relintai", # Username - "github_repo": "entity_spell_system", # Repo name - "github_version": "master", # Version - "conf_py_path": "/docs/", # Path in the checkout to the docs root -} - -#html_logo = 'img/docs_logo.png' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# These paths are either relative to html_static_path -# or fully qualified paths (eg. https://...) -html_css_files = [ - 'css/custom.css', -] - -# Output file base name for HTML help builder -htmlhelp_basename = 'ESSdoc' - -# -- Options for reStructuredText parser ---------------------------------- - -# Enable directives that insert the contents of external files -file_insertion_enabled = False diff --git a/docs/create_class_docs.sh b/docs/create_class_docs.sh deleted file mode 100755 index b821c77..0000000 --- a/docs/create_class_docs.sh +++ /dev/null @@ -1,2 +0,0 @@ - -python ../../../doc/tools/makerst.py ../doc_classes/ -o classes/ diff --git a/docs/entities/ai.rst b/docs/entities/ai.rst deleted file mode 100644 index f42d4b7..0000000 --- a/docs/entities/ai.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _doc_entities_ai: - - -AI -== - - -EntityAI \ No newline at end of file diff --git a/docs/entities/auras.rst b/docs/entities/auras.rst deleted file mode 100644 index 57e1a16..0000000 --- a/docs/entities/auras.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _doc_entities_auras: - -Auras -===== - - -AuraData \ No newline at end of file diff --git a/docs/entities/bags.rst b/docs/entities/bags.rst deleted file mode 100644 index d12c41a..0000000 --- a/docs/entities/bags.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _doc_entities_bags: - -Bags -==== - -For implementing inventories use the :ref:`Bag` base class. - -Right now :ref:`Bags` implements a really simple system (think of Skyrim). -Later more implementations will be added (as subclasses). -If you need a Diablo-like inventory grid, this is a work-in-progress version: -https://github.com/Relintai/entity_spell_system/blob/master/inventory/grid_bag.h -It's not in the build right now, but at least you won't start from scratch, if you want to create one -like this. The item size properties were removed from items, they'll be added back. - -Every :ref:`Entity` contains a :ref:`Bags` property, both server, and clientside. -See :ref:`Entity.sbag`, and :ref:`Entity.cbag`. - -For networked players, whenever the contents of an :ref:`Entity`'s bag changes, the -system automatically sends a message to the :ref:`Entity`'s owner, thus keeping the -state consistent on both server and client. - -The system can also send a bag's contents all at once, for example this happens whenever you replace an -:ref:`Entity`'s bags, using the serverside properties. - -By default Entities won't actually create their own bags, because for example mobs don't need bags by default. - -.. note:: Right now for the player the :ref:`setup_actionbars` will allocate bags. - This will be changed. Also since the module needs the ability to easily switch bag implementations, bag - allocation will probably be pushed into a virtual function, like setup_bags() -> _setup_bags() (virtual). - -Target Bags ------------ - -See :ref:`starget_bag`, and :ref:`ctarget_bag`. - -With these it becomes possible to implement checsts, bank, loot, with minimal code. - -For example when a mob dies, loot is generated into their bags, then when you click their corpse, that bag gets set -as you player's target bag. When you do this, the system sends the contents to that player, and they can manipulate -the contents, based on what the server allows. - -If you want to see how to setup loot interaction, check the _son_death method here: -https://github.com/Relintai/broken_seals/blob/master/game/player/Mob.gd - -It you want to see how to setup loot, check the _sinteract method here: -https://github.com/Relintai/broken_seals/blob/master/game/scripts/entities/EntityDataGD.gd diff --git a/docs/entities/crafting.rst b/docs/entities/crafting.rst deleted file mode 100644 index fb0e8ae..0000000 --- a/docs/entities/crafting.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _doc_entities_crafting: - -Crafting -======== - -The module supports crafting. In order to set it up, first you'll probably need a gui. - -As a starter you can take Broken Seal's crafting window from here: -https://github.com/Relintai/broken_seals/tree/master/game/ui/crafting - -Or if you want to implement one yourself, implement the ability to your window to display recipes, -and then you can just get recipes from your target entity with functions like -:ref:`getc_craft_recipe` **(** int craft_recipe **)** , -and :ref:`getc_craft_recipe_count` **(** **)**. - -.. note:: You usually want to use the client side functions/properties for uis. The serverside - versions will have the ability to have additional, hidden entries. This will allow - for more effects, for example you can remove the player's ability to temporarily - see/craft certain things, without them actually forgeting them. diff --git a/docs/entities/data.rst b/docs/entities/data.rst deleted file mode 100644 index 2f5e855..0000000 --- a/docs/entities/data.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _doc_entities_data: - -Data -==== - - -Data - - -EntityData -EntityClassData - diff --git a/docs/entities/entity.rst b/docs/entities/entity.rst deleted file mode 100644 index 84ca632..0000000 --- a/docs/entities/entity.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _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 deleted file mode 100644 index 28853e5..0000000 --- a/docs/entities/introduction.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _doc_entities_introduction: - -Introduction -============ - - diff --git a/docs/entities/levels.rst b/docs/entities/levels.rst deleted file mode 100644 index 2e9fab0..0000000 --- a/docs/entities/levels.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _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/networking.rst b/docs/entities/networking.rst deleted file mode 100644 index ea9cf77..0000000 --- a/docs/entities/networking.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _doc_entities_networking: - -Networking -========== - -warnings - -architecture + conventions - -vrpc + visibility \ No newline at end of file diff --git a/docs/entities/other.rst b/docs/entities/other.rst deleted file mode 100644 index 87dd3fc..0000000 --- a/docs/entities/other.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _doc_entities_other: - -Other -===== - - - -diff arrays \ No newline at end of file diff --git a/docs/entities/pets.rst b/docs/entities/pets.rst deleted file mode 100644 index 4071a6f..0000000 --- a/docs/entities/pets.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _doc_entities_pets: - -Pets -==== - -warn not yet implemented - -how it will work - -add_pet -> setup - -pet talents - -need to make ui - -mind control - - diff --git a/docs/entities/resources.rst b/docs/entities/resources.rst deleted file mode 100644 index fd18f38..0000000 --- a/docs/entities/resources.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _doc_entities_resources: - -Resources -========= - - -Resources \ No newline at end of file diff --git a/docs/entities/skeleton.rst b/docs/entities/skeleton.rst deleted file mode 100644 index dfde508..0000000 --- a/docs/entities/skeleton.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _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 deleted file mode 100644 index bfb637b..0000000 --- a/docs/entities/skills.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _doc_entities_skills: - - -Skills -====== \ No newline at end of file diff --git a/docs/entities/spells.rst b/docs/entities/spells.rst deleted file mode 100644 index ed150f3..0000000 --- a/docs/entities/spells.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _doc_entities_spells: - -Spells -====== - -spells \ No newline at end of file diff --git a/docs/entities/stats.rst b/docs/entities/stats.rst deleted file mode 100644 index 17006b6..0000000 --- a/docs/entities/stats.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _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 deleted file mode 100644 index e231499..0000000 --- a/docs/entities/talents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _doc_entities_talents: - -Talents -======= - - -talents \ No newline at end of file diff --git a/docs/extensions/gdscript.py b/docs/extensions/gdscript.py deleted file mode 100644 index 34b1c31..0000000 --- a/docs/extensions/gdscript.py +++ /dev/null @@ -1,176 +0,0 @@ -# -*- coding: utf-8 -*- -""" - pygments.lexers.gdscript - ~~~~~~~~~~~~~~~~~~~~~~ - - Lexer for GDScript. - - :copyright: Copyright 2xxx by The Godot Engine Community - :license: MIT. - - modified by Daniel J. Ramirez based on the original python.py pygment -""" - -import re - -from pygments.lexer import Lexer, RegexLexer, include, bygroups, using, \ - default, words, combined, do_insertions -from pygments.util import get_bool_opt, shebang_matches -from pygments.token import Text, Comment, Operator, Keyword, Name, String, \ - Number, Punctuation, Generic, Other, Error -from pygments import unistring as uni - -__all__ = ['GDScriptLexer'] - -line_re = re.compile('.*?\n') - - -class GDScriptLexer(RegexLexer): - """ - For `Godot source code `_ source code. - """ - - name = 'GDScript' - aliases = ['gdscript', 'gd'] - filenames = ['*.gd'] - mimetypes = ['text/x-gdscript', 'application/x-gdscript'] - - def innerstring_rules(ttype): - return [ - # the old style '%s' % (...) string formatting - (r'%(\(\w+\))?[-#0 +]*([0-9]+|[*])?(\.([0-9]+|[*]))?' - '[hlL]?[E-GXc-giorsux%]', String.Interpol), - # backslashes, quotes and formatting signs must be parsed one at a time - (r'[^\\\'"%\n]+', ttype), - (r'[\'"\\]', ttype), - # unhandled string formatting sign - (r'%', ttype), - # newlines are an error (use "nl" state) - ] - - tokens = { - 'root': [ - (r'\n', Text), - (r'^(\s*)([rRuUbB]{,2})("""(?:.|\n)*?""")', - bygroups(Text, String.Affix, String.Doc)), - (r"^(\s*)([rRuUbB]{,2})('''(?:.|\n)*?''')", - bygroups(Text, String.Affix, String.Doc)), - (r'[^\S\n]+', Text), - (r'#.*$', Comment.Single), - (r'[]{}:(),;[]', Punctuation), - (r'\\\n', Text), - (r'\\', Text), - (r'(in|and|or|not)\b', Operator.Word), - (r'!=|==|<<|>>|&&|\+=|-=|\*=|/=|%=|&=|\|=|\|\||[-~+/*%=<>&^.!|$]', Operator), - include('keywords'), - (r'(func)((?:\s|\\\s)+)', bygroups(Keyword, Text), 'funcname'), - (r'(class)((?:\s|\\\s)+)', bygroups(Keyword, Text), 'classname'), - include('builtins'), - ('([rR]|[uUbB][rR]|[rR][uUbB])(""")', - bygroups(String.Affix, String.Double), 'tdqs'), - ("([rR]|[uUbB][rR]|[rR][uUbB])(''')", - bygroups(String.Affix, String.Single), 'tsqs'), - ('([rR]|[uUbB][rR]|[rR][uUbB])(")', - bygroups(String.Affix, String.Double), 'dqs'), - ("([rR]|[uUbB][rR]|[rR][uUbB])(')", - bygroups(String.Affix, String.Single), 'sqs'), - ('([uUbB]?)(""")', bygroups(String.Affix, String.Double), - combined('stringescape', 'tdqs')), - ("([uUbB]?)(''')", bygroups(String.Affix, String.Single), - combined('stringescape', 'tsqs')), - ('([uUbB]?)(")', bygroups(String.Affix, String.Double), - combined('stringescape', 'dqs')), - ("([uUbB]?)(')", bygroups(String.Affix, String.Single), - combined('stringescape', 'sqs')), - include('name'), - include('numbers'), - ], - 'keywords': [ - (words(( - 'and', 'in', 'not', 'or', 'as', 'breakpoint', 'class', 'class_name', - 'extends', 'is', 'func', 'setget', 'signal', 'tool', 'const', - 'enum', 'export', 'onready', 'static', 'var', 'break', 'continue', - 'if', 'elif', 'else', 'for', 'pass', 'return', 'match', 'while', - 'remote', 'master', 'puppet', 'remotesync', 'mastersync', - 'puppetsync'), suffix=r'\b'), - Keyword), - ], - 'builtins': [ - (words(( - 'Color8', 'ColorN', 'abs', 'acos', 'asin', 'assert', 'atan', 'atan2', - 'bytes2var', 'ceil', 'char', 'clamp', 'convert', 'cos', 'cosh', - 'db2linear', 'decimals', 'dectime', 'deg2rad', 'dict2inst', - 'ease', 'exp', 'floor', 'fmod', 'fposmod', 'funcref', 'hash', - 'inst2dict', 'instance_from_id', 'is_inf', 'is_nan', 'lerp', - 'linear2db', 'load', 'log', 'max', 'min', 'nearest_po2', 'pow', - 'preload', 'print', 'print_stack', 'printerr', 'printraw', - 'prints', 'printt', 'rad2deg', 'rand_range', 'rand_seed', - 'randf', 'randi', 'randomize', 'range', 'round', 'seed', 'sign', - 'sin', 'sinh', 'sqrt', 'stepify', 'str', 'str2var', 'tan', - 'tan', 'tanh', 'type_exist', 'typeof', 'var2bytes', 'var2str', - 'weakref', 'yield'), - prefix=r'(?` -======================================= - -Contains common Entity-related enums. - -It has an unnamed enum containing the following values: - -MAX_LEVEL = 50, -BASE_XP = 50, -GENDER_COUNT = 2 - -Unfortunately, to chenge these, you will need to recompile the engine. -This will be fixed later. - -:ref:`EntityType ` ------------------------------------------------ - -Entity type, like beast, creature, object, humanoind, etc. - -See :ref:`Entity.sentity_flags `, and :ref:`Entity.centity_flags `. - - -:ref:`EntityController ` ------------------------------------------------------------ - -Is the entity controlled by a player, or an ai. Will be used for pets, can be used for -narrative things aswell, also mind control like effects. - -See :ref:`Entity.sentity_flags `, and :ref:`Entity.centity_flags `. - - -:ref:`EntityFlags ` -------------------------------------------------- - -Contains generic flags, like untargetable, hidden, interactable, etc. - -See :ref:`Entity.sentity_flags `, and -:ref:`Entity.centity_flags `. - - -:ref:`EntityStateTypeFlags ` -------------------------------------------------------------------- - -Contains flags for effects. For example Stun, Root, Fear etc. Use these to check if -an entity has a particular effect. - -.. note:: Don't set flags directly with the :ref:`Entity.sentity_flags ` - property, because the flags are calculated (refcount). Seen the (EntityStateTypeIndexes) - section below. - -This is how you can check serverside if an entity is stunned: - -.. code-block:: gdscript - - if entity.gets_state() & EntityEnums.ENTITY_STATE_TYPE_FLAG_STUN != 0: - print('stunned') - -See :ref:`Entity.sentity_flags `, -and :ref:`Entity.centity_flags `. - -:ref:`EntityStateTypeIndexes ` ------------------------------------------------------------------------ - -For ease of use, Entity refcounts states, this is the enum, used to do it. When you want to add a state to an -entity, you need to use See :ref:`Entity.adds_state_ref() `, -when you want to remove states use :ref:`Entity.removes_state_ref() `. - -.. note:: This in only available serverside. - -For exmaple let's add a stun to an Entity: - -.. code-block:: gdscript - - entity.adds_state_ref(EntityEnums.ENTITY_STATE_TYPE_INDEX_STUN) - -Let's remove it: - -.. code-block:: gdscript - - entity.removes_state_ref(EntityEnums.ENTITY_STATE_TYPE_INDEX_STUN) - -Since these states are refcounted, everything will work, even if you have multiple sources stunning an entity. - -.. note:: add, and remove_ref will recalculate, and set the :ref:`Entity.sentity_flags ` - whenever needed. Also note, that :ref:`Entity.sentity_flags ` will - syncronize itself over the network, into :ref:`Entity.centity_flags `. - -:ref:`EntityImmunityFlags ` ------------------------------------------------------------------ - -You can set entity immunities with this. - -See :ref:`Entity.simmunity_flags `. (Serverside only). - -Let's make an entity immune to stun, and root: - -.. code-block:: gdscript - - entity.simmunity_flags = EntityEnums.ENTITY_IMMUNITY_FLAG_STUN | ENTITY_IMMUNITY_FLAG_ROOT - -:ref:`CharacterSkeletonPoints ` -------------------------------------------------------------------------- - -Contains all the points/bones of the standard skeleton. With the current implementation, these are the bones, -that you can apply equipments to, add effects to, etc. - -Of course it's up to each skeleton setup, to determine what to implement, and how to handle these in the end, -so even though this has it's limitations, there is still a lot of flexility. For example if you create a beast -skeleton, that class can just ignore any equipment's visuals. - -.. note:: I do have some issues with this solution, because you will need to change, and recompile to add your own bones, - I'm thinking about a better solution. The main reason it's not that easy, is because this gives huge amounts - of convenience when creating equipment for example. You can check :ref:`ItemVisual ` to see why. - -:ref:`AIStates ` -------------------------------------------- - -The run of the mill AI FSM states. - -:ref:`PetStates ` ---------------------------------------------- - -Will be merged into AIStates, because it will make pet support a lot simpler. - -:ref:`EntityInteractionType ` ---------------------------------------------------------------------- - -How an entity should interact when an another one wants to :ref:`interact ` with it. - -Speak, Loot, Use, etc. - -:ref:`EntityClassPlaystyleType ` ---------------------------------------------------------------------------- - -For ai scripts. So they can tell whether a class is ranged or not. - -:ref:`EntityGender ` ---------------------------------------------------- - -Well. gender. It's an enum, because it saves work on bindings. Look at the c++ code of -:ref:`ItemVisualEntry ` if you want to see why. - -:ref:`EntityWindows ` ------------------------------------------------------ - -Allows the server to open different windows on the client. For example loot window, interaction windows, etc. - -.. note:: The bindings in entity for this are using ints, so you can implement you own windows really easily. - The ide is similar to NOTIFICATION-s in Node, and derived types. - diff --git a/docs/general/enums/index.rst b/docs/general/enums/index.rst deleted file mode 100644 index 075fbb4..0000000 --- a/docs/general/enums/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _doc_general_enums: - -Enums -===== - -These are helper classes containing huge amounts of enums. - -They exists, because if these were in their own respective classes, for example -Entity for EntityEnums, then Entity would need to be included by pretty much almost every class, -but Entity also includes a lot of things, which means a lot of boilerplate forward declarations, and also -this would slow down incremental compile times considerably. So for convenience, these classes were born. - -.. toctree:: - :maxdepth: 1 - :caption: Enums - :name: sec-enums - - entity_enums - spell_enums - item_enums \ No newline at end of file diff --git a/docs/general/enums/item_enums.rst b/docs/general/enums/item_enums.rst deleted file mode 100644 index 254157e..0000000 --- a/docs/general/enums/item_enums.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _doc_general_item_enums: - -:ref:`Item Enums ` -=================================== - -Contains item-related enums. - -:ref:`ItemRarity ` ---------------------------------------------- - -Yout can set the visual rarity representation with this. - -:ref:`ItemRarityFlag ` ------------------------------------------------------ - -For generated items. You can set with it which rarities can happen. - -:ref:`ItemType ` ------------------------------------------ - -Main item type / category. - -Contains things like equipment, weapont, potion, herb, etc. - -:ref:`ItemSubtype ` ------------------------------------------------ - -Subtype. Like axe, mace, quest item etc. - -:ref:`ItemSubSubtype ` ------------------------------------------------------ - -SubSubtype. Like One hand, Two Hand etc. - -.. note:: I don't like this setup, I'll try to make this better. - -:ref:`EquipSlots ` ---------------------------------------------- - -The equipslots you want for your character. - -Head, Neck, Shoulders etc. - -.. note:: I don't like this setup, I'll try to make this better (Somehow make it easily changeable). - Maybe make it customiyable with a macro from a central file somehow. TODO (Same will be - applied, to any enum which should be customizable) - -:ref:`ArmorType ` -------------------------------------------- - -Armor types. Cloth, Leather, etc. - -:ref:`EntityTextureLayers ` ---------------------------------------------------------------- - -Texture Layers for merging equipment textures, so you can color skins, eyes etc, and then merge -(and also possibly color) equipment textures. - -Think of equipment coloring in Diablo 3. diff --git a/docs/general/enums/spell_enums.rst b/docs/general/enums/spell_enums.rst deleted file mode 100644 index 848e0cb..0000000 --- a/docs/general/enums/spell_enums.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _doc_general_spell_enums: - -:ref:`Spell Enums ` -===================================== - -Contains Spell-related enums. - -:ref:`DamageType ` ----------------------------------------------- - -The type of damage. It's a flag, so you can combine them. - -Like Melee, Holy, Shadow etc. - -:ref:`SpellCategory ` ----------------------------------------------------- - -Helps to filter spells when needed. Like Normal, Alchemy, Cooking etc. - -:ref:`SpellType ` --------------------------------------------- - -At the moment contains the same entries as :ref:`DamageType `, -also a flag, can be used for interrupt lockouts. - -:ref:`DiminishingReturnCategory ` ----------------------------------------------------------------------------- - -Categories for diminishing returns. Root, Stun, etc. - -:ref:`TriggerEvents ` ----------------------------------------------------- - -Triggen event categories. These are not yet implemented. The ide behind these is to be able to -create some reative effects, using Aura's inspector. - -Think of an aura that gives a 10% chance to stun an enemy (a.k.a apply an aura), when they (ON_HIT) hit the owner. - -:ref:`AuraType ` ------------------------------------------- - -Type of an aura. Like None, Magic, Poison etc. - -You can make these show up in the ui, also some spell can operate on different types. - -They can also be used as flags. - -:ref:`ColliderType ` --------------------------------------------------- - -Collider type for aoes, to intersect with. - -:ref:`TargetType ` ----------------------------------------------- - -This is used by WorldSpell, to know where to "aim". diff --git a/docs/general/globals/entity_data_manager.rst b/docs/general/globals/entity_data_manager.rst deleted file mode 100644 index 24e1feb..0000000 --- a/docs/general/globals/entity_data_manager.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _doc_general_entity_data_manager: - - -:ref:`Entity Data Manager` -=================================================== - -Loads / stores all the data the module needs, like classes, spells, auras, etc, also -it will have convenience methods to spawn Entities, it will also -handle :ref:`Entity` spawning over the network. -:ref:`Entity` spawning is only implemented in gdscript at the moment, -will be ported soon. - -All loaded data classes have an id property, also these need to be unique -between them. - -Right now you will need to populate every folder property, like -:ref:`auras_folder`. -The Manager loads everything from the given folders. If you don't use some of the -resources that has a folder property for it, switch off -:ref:`automatic_load`, and only load -the things you need. You can use methods like -:ref:`load_auras`. - -ESS uses this data to spawn things over the network. - -Right now you always need to have this class in the scene before spawning an -:ref:`Entity`. Later this restriction will only apply if you -want to use networking. - -You can script the loading behaviours by turning off the -:ref:`automatic_load` property -in the instector. - -The manager's scripting api allows you to fully customize loading. -You can add even dd every class one by one if you want to. -This also allows for procedurally generating data if you want to. -However if you do this, and also use networking, you need to make sure to to -generate the same spells aswell on clients aswell. \ No newline at end of file diff --git a/docs/general/globals/globals.rst b/docs/general/globals/globals.rst deleted file mode 100644 index 26e6907..0000000 --- a/docs/general/globals/globals.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _doc_general_globals: - -Globals -======= - -These are the global classes of the module. - -Right now both need to exist in the scene before you spawn entities. - -I recommend adding them as autoloads. - -Later both will be optional, in the case of profile manager, this is really simple, -however in the case of data manager, this is going to be more difficult. Also for -data manager it will only be possible if networking is disabled. - - -.. toctree:: - :maxdepth: 1 - :caption: Globals - :name: sec-globals-cat - - entity_data_manager - profile_manager diff --git a/docs/general/globals/profile_manager.rst b/docs/general/globals/profile_manager.rst deleted file mode 100644 index b0dcef6..0000000 --- a/docs/general/globals/profile_manager.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _doc_general_profile_manager: - - -:ref:`Profile Manager` -============================================ - -Saves/loads player profiles. - -A Player profile pretty much is an array of :ref:`ClassProfiles`. - -Every :ref:`ClassProfile` contains actionbar information, class level information, -and it will (right now there is one placeholder class for this) contain keybind information. - -Right now having this class inside the SceneTree is required before spawning entities. -This will change in the future. - -In the future the data it saves will be more customizable by scripts. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 46e81ef..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,109 +0,0 @@ -Welcome to Entity-Spell System's documentation! -=============================================== - - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. toctree:: - :maxdepth: 1 - :caption: About - :name: sec-about - - introduction/introduction - introduction/compiling - introduction/design - introduction/optional_dependencies - introduction/companion_addon - introduction/todos - -.. toctree:: - :maxdepth: 1 - :caption: General - :name: sec-general - - general/globals/globals - general/enums/index - -.. 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/pets - entities/networking - 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: UI - :name: sec-ui - - ui/drag_and_drop - -.. toctree:: - :maxdepth: 1 - :caption: FAQ - :name: sec-faq - - faq/procedural_generation - -.. toctree:: - :maxdepth: 1 - :caption: Class reference - :name: sec-class-ref - - classes/index - -.. Indices and tables -.. ------------------ -.. -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search` \ No newline at end of file diff --git a/docs/introduction/companion_addon.rst b/docs/introduction/companion_addon.rst deleted file mode 100644 index 6bd0730..0000000 --- a/docs/introduction/companion_addon.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _doc_introduction_companion_addon: - -Companion Addon -=============== - -Entity and spell system has a companion addon, to help keep all the data organized. - -You can get it from here: - -https://github.com/Relintai/ess_data.git - -It needs a .json file in the root of you project. - -See https://github.com/Relintai/broken_seals/blob/master/game/ess_data.json \ No newline at end of file diff --git a/docs/introduction/compiling.rst b/docs/introduction/compiling.rst deleted file mode 100644 index f366709..0000000 --- a/docs/introduction/compiling.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _doc_introduction_compiling: - -Compiling -========= - -This is an engine module, which means you'll need to compile it into godot yourself. -This might seem really daunting at first, especially if you already ran into complex build systems. -Don't worry though, compiling godot is really easy, simple, and also painless. - -First make sure, that you can compile godot. - -The tutorials for this are here: https://docs.godotengine.org/en/3.1/development/compiling/ - -Now you should have godot's source code on your computer. - -Now, clone ess like: - -git clone https://github.com/Relintai/entity_spell_system entity_spell_system - -When this finishes copy your newly created entity_spell_system folder, into godot's source's modules folder. -Like: godot/modules/entity_spell_system - -Once this is done, just gompile godot as usual. diff --git a/docs/introduction/design.rst b/docs/introduction/design.rst deleted file mode 100644 index b542a8e..0000000 --- a/docs/introduction/design.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _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 deleted file mode 100644 index 34e097a..0000000 --- a/docs/introduction/introduction.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _doc_introduction_introduction: - -Introduction -============ - -Welcome to the documentation of my entity and spell system godot engine module. - -The main purpose of this module is to make a complex (mmorpg) like multiplayer spell -and entity setup accessible to everyone. - -The module is created to be really flexible, you don't need to make realtime mmorpgs -with it, for example you can use this in an fps game, or even in a turn based single player roguelike. - -The module is set up to give as much control over everything as possible. - -The source code for the module is here: https://github.com/Relintai/entity_spell_system \ No newline at end of file diff --git a/docs/introduction/optional_dependencies.rst b/docs/introduction/optional_dependencies.rst deleted file mode 100644 index 043b1e1..0000000 --- a/docs/introduction/optional_dependencies.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _doc_introduction_optional_dependencies: - -Optional Dependencies -===================== \ No newline at end of file diff --git a/docs/introduction/todos.rst b/docs/introduction/todos.rst deleted file mode 100644 index 4e08eff..0000000 --- a/docs/introduction/todos.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _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 deleted file mode 100644 index c58ed14..0000000 --- a/docs/items/craft_recipes.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _doc_items_craft_recipes: - -Craft Recipes -============= \ No newline at end of file diff --git a/docs/items/equipment.rst b/docs/items/equipment.rst deleted file mode 100644 index 26f914c..0000000 --- a/docs/items/equipment.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _doc_items_equipment: - -Equipment -========= \ No newline at end of file diff --git a/docs/items/item.rst b/docs/items/item.rst deleted file mode 100644 index 735892b..0000000 --- a/docs/items/item.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _doc_items_item: - -Item -==== \ No newline at end of file diff --git a/docs/items/item_visuals.rst b/docs/items/item_visuals.rst deleted file mode 100644 index d20701f..0000000 --- a/docs/items/item_visuals.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. _doc_items_item_visuals: - -Item Visuals -============ \ No newline at end of file diff --git a/docs/items/loot.rst b/docs/items/loot.rst deleted file mode 100644 index 22b4d9e..0000000 --- a/docs/items/loot.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _doc_items_loot: - -Loot -==== - -Loot -lootdb -will have to change \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 2119f51..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/spells_and_auras/aura.rst b/docs/spells_and_auras/aura.rst deleted file mode 100644 index b994484..0000000 --- a/docs/spells_and_auras/aura.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _doc_spells_and_auras_aura: - -Aura -==== - -Aura diff --git a/docs/spells_and_auras/cooldowns.rst b/docs/spells_and_auras/cooldowns.rst deleted file mode 100644 index bccdcf0..0000000 --- a/docs/spells_and_auras/cooldowns.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _doc_spells_and_auras_cooldowns: - -Cooldowns -========= - -ESS implements two types of cooldowns. These are: - -:ref:`Cooldown` -------------------------------- - -This class is used for a single spell cooldown. - -Later, spells on items will use this aswell. - -:ref:`CategoryCooldown` ------------------------------------------------ - -This class is used for giving categories of spells a cooldown. E.g. interrupts. diff --git a/docs/spells_and_auras/pipelines.rst b/docs/spells_and_auras/pipelines.rst deleted file mode 100644 index da9599d..0000000 --- a/docs/spells_and_auras/pipelines.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _doc_spells_and_auras_pipelines: - -Pipelines -========= - -DamageInfo -HealInfo diff --git a/docs/spells_and_auras/spell.rst b/docs/spells_and_auras/spell.rst deleted file mode 100644 index bd4e360..0000000 --- a/docs/spells_and_auras/spell.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _doc_spells_and_auras_spell: - -Spell -===== - -Spell - -Ray casting! \ No newline at end of file diff --git a/docs/spells_and_auras/spell_visual_effects.rst b/docs/spells_and_auras/spell_visual_effects.rst deleted file mode 100644 index bcf882e..0000000 --- a/docs/spells_and_auras/spell_visual_effects.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _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 deleted file mode 100644 index af77af1..0000000 --- a/docs/spells_and_auras/world_spells.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _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 deleted file mode 100644 index 4881833..0000000 --- a/docs/ui/drag_and_drop.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _doc_ui_srag_and_drop: - -Drag and Drop -============= - -Implement drag & drops using :ref:`ESDragAndDrop`. - -ESS uses this as it's drag & drop helper class. You can easily set up item, and spell -drag & drops with this. - -The meaning of the :ref:`item_id` property changes, based -on the value of the :ref:`type` property. It can mean, spell, itemid, -item slot, and equip slot. - -Don't forget to set the :ref:`origin` property.