Metadata-Version: 2.2
Name: regolith-system-template
Version: 1.0.0
Summary: A Python package for easier reuseability of the System Template Regolith filter for Minecraft Bedrock Edition
Author: Nusiq
License: MIT
Project-URL: Source, https://github.com/Nusiq/regolith-system-template/tree/master
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
License-File: LICENSE

Regolith System Template
========================

A Python package that powers the `System Template Regolith Filter <https://system-template-docs.readthedocs.io/en/stable/>`_ and provides a command line tool for creating projects based on the templates defined using the System Template syntax.

Installation
-------------

.. code-block:: bash

   pip install regolith-system-template


Command Line Tool
-----------------

You can access the commandline tool by running following commoand:

.. code-block:: bash

   system-template <template-name>

This will create a new system based on the template named :code:`<template-name>`.

Before using the command line tool, you should set the :code:`REGOLITH_SYSTEM_TEMPLATE` environment variable to select the path where you can store your systems. The systems should be in subfolders of that directory stored in the same format as the one used by the Regolith filter.

Alternatively you can use :code:`--systems-path` flag to specify the path in the command.

The :code:`--scope-path` lets you specify the path to the file that contains the scope for the execution of the template. This is useful if you want to execute a template from a Regolith project. In that case, use this to specify the path to the project's global Regolith scope.

The :code:`--scope` variable lets you specify an additional scope in JSON format. This takes place of the :code:`scope` configuration option in :code:`config.json` of the Regolith project.

By default the app doesn't work in non-empty directories. It can be changed using the 
:code:`--allow-non-empty` flag.

For more help use the :code:`--help` flag.

Unlike the Regolith filter, the command line tool doesn't limit you to exporing only to :code:`RP/`, :code:`BP/` and :code:`data/` directories.


MIT License

Copyright (c) 2025 Nusiq

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
