From 8b3efd2476bafe32ac09114775acb7df325ce685 Mon Sep 17 00:00:00 2001 From: EmmaM <27428383+emma-miler@users.noreply.github.com> Date: Tue, 15 Feb 2022 20:09:20 +0100 Subject: [PATCH] Added the first few pages Still very much under construction. Want to test the automatic build system --- .gitignore | 4 ++ docs/source/conf.py | 6 +- docs/source/guides/cheatsheet.rst | 5 ++ docs/source/guides/gettingstarted.rst | 80 +++++++++++++++++++++++++ docs/source/guides/moddingtutorials.rst | 5 ++ docs/source/guides/tools.rst | 77 ++++++++++++++++++++++++ docs/source/index.rst | 24 +++++++- docs/source/native/sqvm.rst | 2 + 8 files changed, 198 insertions(+), 5 deletions(-) create mode 100644 docs/source/guides/cheatsheet.rst create mode 100644 docs/source/guides/gettingstarted.rst create mode 100644 docs/source/guides/moddingtutorials.rst create mode 100644 docs/source/guides/tools.rst create mode 100644 docs/source/native/sqvm.rst diff --git a/.gitignore b/.gitignore index a9b7dc72..b309bea1 100644 --- a/.gitignore +++ b/.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 \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 6e9e8c08..589762c4 100644 --- a/docs/source/conf.py +++ b/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' diff --git a/docs/source/guides/cheatsheet.rst b/docs/source/guides/cheatsheet.rst new file mode 100644 index 00000000..7cb07b93 --- /dev/null +++ b/docs/source/guides/cheatsheet.rst @@ -0,0 +1,5 @@ +Cheatsheet +========== + +.. note:: + This project is under active development. \ No newline at end of file diff --git a/docs/source/guides/gettingstarted.rst b/docs/source/guides/gettingstarted.rst new file mode 100644 index 00000000..0148c47d --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/source/guides/moddingtutorials.rst b/docs/source/guides/moddingtutorials.rst new file mode 100644 index 00000000..77c7e021 --- /dev/null +++ b/docs/source/guides/moddingtutorials.rst @@ -0,0 +1,5 @@ +Modding Tutorials +================= + +.. note:: + This project is under active development. \ No newline at end of file diff --git a/docs/source/guides/tools.rst b/docs/source/guides/tools.rst new file mode 100644 index 00000000..fe2e3927 --- /dev/null +++ b/docs/source/guides/tools.rst @@ -0,0 +1,77 @@ +Modding Tools +============= + +Source engine +------------- + +Titanfall +^^^^^^^^^ +* `Titanfall VPK Tool `_ +* `Legion `_ + + +RPSNVPK's +^^^^^^^^^ +* `squidgyberries RSPNVPK `_ +* `taskinoz RSPNVPK `_ +* `Provoxin RSPNVPK `_ + +VTF & VMT +^^^^^^^^^ +* `VTFEdit `_ +* `VTF Shell Extensions `_ - `Info `_ + +Other utilities +--------------- + +File editors +^^^^^^^^^^^^ +* `Atom Text `_ + + * `Syntax color KeyValue `_ + * `Syntax color Squirrel `_ + * `Color picker `_ + +* `TextCrawler 3 `_ +* `Visual Studio Code `_ +* `VSCodium `_ +* `Notepad++ `_ + +Graphics / animation / color editors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* `Paint.net `_ + + * `Gradient Mapping plug-in `_ + * `Animation Helper `_ + +* `Source VMT Color `_ +* `GIMP `_ + + * `VTF plug-in `_ + +* `RGB Tool converter `_ +* `Color Pick Windows `_ +* `GIF splitter `_ +* `Rad Tools Bik `_ (needs `Quicktime 7.6 `_) + +Archives +^^^^^^^^ +* `7zip `_ + +Driver editors +^^^^^^^^^^^^^^ +* `NVidia Profile Inspector `_ +* `ATI Radeon Tray Tools `_ + +3D Models +^^^^^^^^^ +* `Blender `_ + + * `Blender Source Tool `_ + * `Blender VMT `_ + * `IO import VMF & VMT `_ + +* `Crowbar `_ +* `Ninja Ripper v1.7.1 `_ + +Highly recommended to check the `NoSkill Gitbook modding section `_ for more tools. diff --git a/docs/source/index.rst b/docs/source/index.rst index 03d09a55..e498970e 100644 --- a/docs/source/index.rst +++ b/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 diff --git a/docs/source/native/sqvm.rst b/docs/source/native/sqvm.rst new file mode 100644 index 00000000..0f80a5fe --- /dev/null +++ b/docs/source/native/sqvm.rst @@ -0,0 +1,2 @@ +Squirrel VM +=========== \ No newline at end of file