Merge branch 'documentation-unstable' into documentation

Author: scrlys

.pylintrc

@@ -1,6 +1,10 @@
-README
+AWSW-Modtools
 ======
 
-Please click `this link`_ or see the current documentation inside the docs/ folder.
+AWSW-Modtools is a modding framework for the visual novel _Angels with Scaly Wings_.
+The goal is to have an easy-to-use modding framework that loads mods and allows mods to expand the game.
+
+Please check out the `installation guide`_ on how to install the modding framework.
+If you'd like to make your own mods or to contribute to the modding effort, please click `this link`_ or see the current documentation inside the docs/ folder.
 
 .. _this link: https://scrlys.github.io/AWSW-Modtools/

README.rst

@@ -1,5 +1,8 @@
-modlib
+API
 ------
 
-.. automodule:: modloader.modlib
+.. automodule:: modloader.modgame
+    :members:
+
+.. automodule:: modloader.modast
     :members:

docs/API.rst

@@ -6,10 +6,20 @@ Documenting the code, especially the API, is critical to ensure that the modding
 Style Guide
 -----------
 
-All the Python code must follow `PEP 8`_. The docstrings must follow `Google's style guide`_.
+All the Python code must follow `PEP 8`_. The docstrings must follow Napoleon, Google's docstring style. You can find more information in `Google's style guide`_ and `Sphinx documentation`_
+Before merging into any major branch, ensure that pylint returns no problems.
+
+To execute pylint under a Unix environment:
+
+* Install normally through Python 2's pip
+* Enter the game/ folder in the installation directory
+* Run ``pylint modloader``
+
+To run pylint for mods, run ``pylint mods/modname`` where modname is the mod's name.
 
 .. _PEP 8: https://www.python.org/dev/peps/pep-0008/
 .. _Google's style guide: https://google.github.io/styleguide/pyguide.html#Comments
+.. _Sphinx documentation: http://www.sphinx-doc.org/en/stable/ext/napoleon.html
 
 Building Documentation
 ----------------------

docs/documentation.rst

@@ -1,58 +1,73 @@
-import renpy
+"""This file is free software under the GPLv3 license."""
+
 import os
 import sys
-import modinfo
 import importlib
-import modinfo
-import modclass
+import renpy
+from modloader import modinfo, modclass
+
+print 'AWSW Mod Loader Init'
 
-print('AWSW Mod Loader Init')
 
 def get_mod_path():
     """Get the mod path
 
     Returns:
         The full path to the mods folder
     """
-    #TODO: Use a path combining function
-    return renpy.config.gamedir + "/mods/"
+    return os.path.join(renpy.config.gamedir, "mods")
+
 
 def main():
-    # By setting the import path to the mod folder, we can do something like `import mod`
-    # NOTE: To import files in the modloader/ folder, do `from modloader import ...`
-    # If we add the modloader to the path, the modlist would get reloaded again
+    """Load the mods"""
+    # By appending the mod folder to the import path we can do something like
+    # `import test` to import the mod named test in the mod folder.
     sys.path.append(get_mod_path())
+    # NOTE: To import files in the modloader/ folder, do
+    # `from modloader import ...`. If we add the modloader to the path,
+    # the modules would be reimported every time they are imported.
+    # In most cases, that's fine, but when modinfo is reimported, we lose the
+    # current list of mods.
 
     for mod in os.listdir(get_mod_path()):
-        # Some mods require resources to be recognized by renpy. If a folder exists, force renpy to load it
-        resource_dir = get_mod_path() + mod + "/resource"
+        # Some mods require resources to be recognized by renpy.
+        # If a folder exists, force renpy to load it
+        resource_dir = os.path.join(get_mod_path(), mod, 'resource')
         if os.path.isdir(resource_dir):
             renpy.config.searchpath.append(resource_dir)
 
-        # Try importing the mod. If all goes well, the mod is imported through the Mod class
-        print("Begin mod load: {}".format(mod))
+        print "Begin mod load: {}".format(mod)
 
+        # Try importing the mod.
+        # Note: This doesn't give my mod functionality. To give the mod
+        # function, make a Mod class and apply the loadable_mod decorator
         mod_object = importlib.import_module(mod)
 
-        # Run through registry to see if the mod implements loadable_mod in some way. 
-        if not any(modinfo.get_mods()[key][4] == mod_object for key in modinfo.get_mods()):
-            modinfo.add_mod(mod_object.__name__, (None, "", "", "", mod_object))
+        # Put the mod into the registry if it doesn't already exist
+        # This is for legacy detection of the previous mod importation system
+        # Avoid using this as it might get removed in later commits
+        mods = modinfo.get_mods()
+        if not any(mods[key][4] == mod_object for key in mods):
+            info = (None, "", "", "", mod_object)
+            modinfo.add_mod(mod_object.__name__, info)
 
-    # After all ods are loaded, call their respective mod_complete functions
+    # After all mods are loaded, call their respective mod_complete functions
     for mod_name, mod_data in modinfo.get_mods().iteritems():
         if mod_data[0]:
-            print("Completing mod {}".format(mod_name))
+            print "Completing mod {}".format(mod_name)
             mod_data[0].mod_complete()
 
-    # force renpy to reindex all game files
+    # Force renpy to reindex all game files
     renpy.loader.old_config_archives = None
 
-# Ensure that we have a stable renpy environment.
-# The documentation won't have a stable renpy.config.gamedir, but the game will
+# When we build the documentation, renpy.config.gamedir will not exist
+# However, when the game is ran, it will exist. We take abuse of that
 
 try:
-    renpy.config.gamedir
-    building_documentation = False
+    _ = renpy.config.gamedir
+    BUILDING_DOCUMENTATION = False
+except AttributeError:
+    BUILDING_DOCUMENTATION = True
+
+if not BUILDING_DOCUMENTATION:
     main()
-except:
-    building_documentation = True