From 0a3d0774655992cad54790f4b8e532be7fda1876 Mon Sep 17 00:00:00 2001 From: ASpoonPlaysGames <66967891+ASpoonPlaysGames@users.noreply.github.com> Date: Wed, 4 Sep 2024 19:22:49 +0100 Subject: [PATCH 1/2] document new rpak loading stuff --- docs/source/guides/tools/rpakmodding.rst | 46 ++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/tools/rpakmodding.rst b/docs/source/guides/tools/rpakmodding.rst index cc114fab..4c699c80 100644 --- a/docs/source/guides/tools/rpakmodding.rst +++ b/docs/source/guides/tools/rpakmodding.rst @@ -182,8 +182,41 @@ Inside the mod's folder, create a new folder, called ``paks``. Move your .rpak f |ModStructure| Inside the ``paks`` folder that you created, make a new .json file called ``rpak.json``. -In this example, the ``camo_skin04_col.rpak`` rpak is completely replaced by ``example.rpak``. -This is fine for camo RPaks, but isn't suitable for more complex RPaks +In this example, the ``example.rpak`` RPak is loaded on every map. +This is fine for camo RPaks, but isn't suitable for more complex RPaks. + +.. code-block:: json + + { + "example.rpak": "." + } + +Dynamic Map loading +******************* + +To dynamically load your RPak, add an entry to the ``rpak.json`` that matches the path to the RPak (relative to the ``rpak.json`` file) and +set the value to some Regex that matches the maps that you wish. + +.. code-block:: json + + { + "foo.rpak": ".", + "bar.rpak": "mp_", + "baz.rpak": "mp_glitch", + "qux.rpak": "mp_coliseum|mp_colony02|mp_glitch" + } + +- ``foo.rpak``: this RPak will be loaded on all maps. +- ``bar.rpak``: this RPak will be loaded on all maps that contain ``mp_`` in their name +- ``baz.rpak``: this RPak will be loaded on all maps that contain ``mp_glitch`` in their name (``mp_glitch`` being the intended map) +- ``qux.rpak``: this RPak will be loaded on all maps that contain either ``mp_coliseum``, ``mp_colony02``, or ``mp_glitch`` in their name. +So ``mp_glitch``, ``mp_colony02``, ``mp_coliseum`` and notably, also ``mp_coliseum_column``. + +RPak loading - OLD +****************** + +.. warning:: + Using this old mod structure for your ``rpak.json`` file is deprecated and may stop being supported by Northstar at any time. .. code-block:: json @@ -209,6 +242,9 @@ This is fine for camo RPaks, but isn't suitable for more complex RPaks Preload ******* +.. warning:: + "Preload" is now deprecated. New RPak mods should use dynamic map loading to load their RPaks. + This field tells Northstar whether or not to load a specific RPak as soon as RPak loading starts. The field is a boolean. (``true`` or ``false``) and should be formatted like ``"": true`` or ``"": false`` @@ -218,6 +254,9 @@ Example: ``"my_new.rpak": true`` Aliases ******* +.. warning:: + "Aliases" is now deprecated. New RPak mods should use dynamic map loading to load their RPaks. + This field tells Northstar that a specific RPak should never be loaded, and a different RPak should be loaded instead. The field should be formatted like ``"": ""`` @@ -227,6 +266,9 @@ Example: ``"common.rpak": "my_new.rpak"`` Postload ******** +.. warning:: + Postload is now deprecated. New RPak mods should use dynamic map loading to load their RPaks. + This field tells Northstar that a specific RPak must be loaded directly after another specified RPak has finished loading. The field should be formatted like ``"": ""`` From 8c24791a2d0e6dee2979e946308c5fd0c0ffd50b Mon Sep 17 00:00:00 2001 From: ASpoonPlaysGames <66967891+ASpoonPlaysGames@users.noreply.github.com> Date: Wed, 4 Sep 2024 19:28:00 +0100 Subject: [PATCH 2/2] newline stuff --- docs/source/guides/tools/rpakmodding.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/tools/rpakmodding.rst b/docs/source/guides/tools/rpakmodding.rst index 4c699c80..535f4e47 100644 --- a/docs/source/guides/tools/rpakmodding.rst +++ b/docs/source/guides/tools/rpakmodding.rst @@ -209,8 +209,8 @@ set the value to some Regex that matches the maps that you wish. - ``foo.rpak``: this RPak will be loaded on all maps. - ``bar.rpak``: this RPak will be loaded on all maps that contain ``mp_`` in their name - ``baz.rpak``: this RPak will be loaded on all maps that contain ``mp_glitch`` in their name (``mp_glitch`` being the intended map) -- ``qux.rpak``: this RPak will be loaded on all maps that contain either ``mp_coliseum``, ``mp_colony02``, or ``mp_glitch`` in their name. -So ``mp_glitch``, ``mp_colony02``, ``mp_coliseum`` and notably, also ``mp_coliseum_column``. +- | ``qux.rpak``: this RPak will be loaded on all maps that contain either ``mp_coliseum``, ``mp_colony02``, or ``mp_glitch`` in their name. + | So ``mp_glitch``, ``mp_colony02``, ``mp_coliseum`` and notably, also ``mp_coliseum_column``. RPak loading - OLD ******************