Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document new rpak loading stuff #251

Closed
wants to merge 2 commits into from
Closed

Document new rpak loading stuff #251

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a3d077
document new rpak loading stuff
ASpoonPlaysGames Sep 4, 2024
8c24791
newline stuff
ASpoonPlaysGames Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions docs/source/guides/tools/rpakmodding.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 ``"<target_rpak>": true`` or ``"<target_rpak>": false``
Expand All @@ -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 ``"<target_rpak>": "<replacement_rpak>"``
Expand All @@ -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 ``"<target_rpak>": "<rpak_to_load_after>"``
Expand Down