Added the first few pages

Still very much under construction.
Want to test the automatic build system

.gitignore

@@ -154,3 +154,7 @@ dmypy.json
 cython_debug/
 
 # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+
+# repo specific stuff
+.vscode
+docs/source/_build

docs/source/conf.py

@@ -2,9 +2,9 @@
 
 # -- Project information
 
-project = 'Lumache'
-copyright = '2021, Graziella'
-author = 'Graziella'
+project = 'Northstar Modding Documentation'
+copyright = '2022, Northstar Developer Team'
+author = 'Northstar Developer Team'
 
 release = '0.1'
 version = '0.1.0'

docs/source/guides/cheatsheet.rst

@@ -0,0 +1,5 @@
+Cheatsheet
+==========
+
+.. note::
+    This project is under active development.

docs/source/guides/gettingstarted.rst

@@ -0,0 +1,80 @@
+Getting Started
+===================================
+
+Northstar supports the creation of many user mods. 
+This guide will teach you the basics of modding to get you started.
+
+Check out the :doc:`usage` section for further information, including
+:ref:`installation`.
+
+Basics
+------
+
+This guide assumes you have basic understanding with programming and know how to use developer environments. Listed below are tools useful for exporting file formats
+
+If you'd like a more lengthy set of tutorials covering many topics. Look at:
+
+:doc:`moddingtutorials`
+
+Tools
+-----
+* RSPNVPK
+* Cra0 VPK Tool (Titanfall VPK Tool)
+* Legion by DZXTPorter
+
+.. TODO actually link the tools here
+
+
+Quick Start
+-----------
+In order to get started with making your mod, create a folder in ``R2Northstar/mods``. 
+While it isn't required, it is best practise by mod authors to follow the naming scheme ``Author.ModName``, such as ``Northstar.Client``.
+
+After making this folder, inside it add a folder named ``mod`` and a file named ``mod.json``.
+
+Provided is a template ``mod.json``, for a detailed list of values read the :doc:`cheatsheet`
+
+
+.. code-block:: json
+
+   {
+      "Name": "Yourname.Modname",
+      "Description": "Woo yeah wooo!",
+
+      "LoadPriority": 0,
+      "ConVars": [],
+      "Scripts": [],
+      "Localisation": []
+   }
+
+Inside the ``mod`` folder, existing files found in the engine's virtual file system will be overwritten and new files can be added.
+If you need to define new Squirrel files ``(.nut/.gnut)`` they *must* be declared in the ``"Scripts"`` array in `mod.json`.
+An example for this might be:
+
+.. code-block:: json
+
+   "Scripts": [
+      {
+         "Path": "path/to/file.nut",
+         "RunOn": "( CLIENT || SERVER ) && MP"
+      },
+      {
+         "Path": "path/to/another_file.nut",
+         "RunOn": "( CLIENT || SERVER ) && MP",
+         "ClientCallback": {
+            "Before": "ClientPreMapspawnThing",
+            "After": "AfterMapspawnClientThing"
+         },
+         "ServerCallback": {
+            "Before": "ServerPreMapspawncrap",
+            "After": "ServerAfterMapspawnWoo"
+         }
+      }
+   ]
+
+
+``"Path"`` indicates where the script is, ``"RunOn"`` is the Squirrel VM context (see :doc:`../native/sqvm`) as an expression, and ``"ClientCallback"`` and ``"ServerCallback"`` specify a function call that can be ``"Before"`` and/or ``"After"`` map-spawn.
+
+.. note::
+
+   This project is under active development.

docs/source/guides/moddingtutorials.rst

@@ -0,0 +1,5 @@
+Modding Tutorials
+=================
+
+.. note::
+    This project is under active development.

docs/source/guides/tools.rst

@@ -0,0 +1,77 @@
+Modding Tools
+=============
+
+Source engine
+-------------
+
+Titanfall
+^^^^^^^^^
+* `Titanfall VPK Tool <http://cra0kalo.com/public/Titanfall\_VPKTool3.4\_Portable.zip>`_
+* `Legion <https://wiki.modme.co/wiki/apps/Legion.html>`_
+
+
+RPSNVPK's
+^^^^^^^^^
+* `squidgyberries RSPNVPK <https://github.com/squidgyberries/RSPNVPK>`_
+* `taskinoz RSPNVPK <https://github.com/taskinoz/RSPNVPK>`_
+* `Provoxin RSPNVPK <https://github.com/Provoxin/RSPNVPK-GUI>`_
+
+VTF & VMT
+^^^^^^^^^
+* `VTFEdit <https://developer.valvesoftware.com/wiki/VTFEdit>`_
+* `VTF Shell Extensions <https://www.wunderboy.org/valve-hl2source-sdk-tools/#vtf\_shell>`_ - `Info <https://developer.valvesoftware.com/wiki/VTF\_Shell\_Extensions>`_
+
+Other utilities
+---------------
+
+File editors
+^^^^^^^^^^^^
+* `Atom Text <https://atom.io>`_
+
+  * `Syntax color KeyValue <https://atom.io/packages/language-source-cfg>`_
+  * `Syntax color Squirrel <https://atom.io/packages/squirrel-language>`_
+  * `Color picker <https://atom.io/packages/color-picker>`_
+
+* `TextCrawler 3 <https://www.digitalvolcano.co.uk/tcdownloads.html>`_
+* `Visual Studio Code <https://code.visualstudio.com>`_
+* `VSCodium <https://vscodium.com>`_
+* `Notepad++ <https://notepad-plus-plus.org/downloads/>`_
+
+Graphics / animation / color editors
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* `Paint.net <https://www.getpaint.net>`_
+
+  * `Gradient Mapping plug-in <https://forums.getpaint.net/topic/6265-gradient-mapping/>`_
+  * `Animation Helper <https://pixelbyte.itch.io/paint-net-sprite-plugin>`_
+
+* `Source VMT Color <https://dev.cra0kalo.com/?p=155>`_
+* `GIMP <https://www.gimp.org/downloads/>`_
+
+  * `VTF plug-in <https://www.tophattwaffle.com/downloads/gimp-vtf-plugin/>`_
+
+* `RGB Tool converter <http://hewmc.blogspot.fr/2012/12/rgb-to-percentage-converter.html>`_
+* `Color Pick Windows <https://pixelbyte.itch.io/color-pick>`_
+* `GIF splitter <https://ezgif.com/split>`_
+* `Rad Tools Bik <http://www.radgametools.com/bnkdown.htm>`_ (needs `Quicktime 7.6 <https://support.apple.com/downloads/quicktime>`_)
+
+Archives
+^^^^^^^^
+* `7zip <https://www.7-zip.org>`_
+
+Driver editors
+^^^^^^^^^^^^^^
+* `NVidia Profile Inspector <https://nvidia-inspector.en.lo4d.com/windows>`_
+* `ATI Radeon Tray Tools <https://www.majorgeeks.com/files/details/ati\_tray\_tools.html>`_
+
+3D Models
+^^^^^^^^^
+* `Blender <https://www.blender.org>`_
+
+  * `Blender Source Tool <https://developer.valvesoftware.com/wiki/Blender\_Source\_Tools>`_
+  * `Blender VMT <https://github.com/lasa01/blender-vmt>`_
+  * `IO import VMF & VMT <https://github.com/lasa01/io\_import\_vmf>`_
+
+* `Crowbar <http://steamcommunity.com/groups/CrowbarTool>`_
+* `Ninja Ripper v1.7.1 <https://gamebanana.com/tools/5638>`_
+
+Highly recommended to check the `NoSkill Gitbook modding section <https://noskill.gitbook.io/titanfall2/how-to-start-modding/modding-introduction/modding-tools>`_ for more tools.

docs/source/index.rst

@@ -17,6 +17,26 @@ Contents
 --------
 
 .. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Guides
+
+   /guides/gettingstarted
+   /guides/tools
+   /guides/cheatsheet
+   /guides/moddingtutorials
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Northstar API Documentation
+
+   /native/sqvm
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Native Documentation
+
+   /native/sqvm
 
-   usage
-   api

docs/source/native/sqvm.rst

@@ -0,0 +1,2 @@
+Squirrel VM
+===========