<commit_before>.. _map_features:

Map Features
============

Importing
---------

SpringBoard doesn't come with any map features besides the engine-default geovent, so if you want to add them you first need to import them into your project.

To import new features you need to perform the following steps:

1. Find existing feature sets (e.g. `SpringFeatures<https://github.com/Spring-Helper-Projects/spring-features>`_) or make your own following the official `Spring docs<https://springrts.com/wiki/Gamedev:FeatureDefs>`_.

2. Copy features into your project and restart.

Below is an example of how to copy ``SpringFeatures`` into a SpringBoard project.

.. image:: img/features/features1.jpg
   :align: center

.. image:: img/features/features2.jpg
:align: center

.. image:: img/features/features3.jpg
:align: center

Exporting as Spring archive (recommended)
-----------------------------------------

**Exporting your project using the "Spring archive" export option will include all features and is the recommended way to export a SpringBoard project.**

Export manually
---------------

Manual export is only recommended if you want to customize the export process (perhaps you want to compile the map yourself using a third-party tool).
In that case you can follow the below tutorial.

s11n export should be used if you want to export game objects (units, features, etc.) and load them in your standalone map.<commit_msg>fix align<commit_after>.. _map_features:

Map Features
============

Importing
---------

SpringBoard doesn't come with any map features besides the engine-default geovent, so if you want to add them you first need to import them into your project.

To import new features you need to perform the following steps:

1. Find existing feature sets (e.g. `SpringFeatures<https://github.com/Spring-Helper-Projects/spring-features>`_) or make your own following the official `Spring docs<https://springrts.com/wiki/Gamedev:FeatureDefs>`_.

2. Copy features into your project and restart.

Below is an example of how to copy ``SpringFeatures`` into a SpringBoard project.

.. image:: img/features/features1.jpg
   :align: center

.. image:: img/features/features2.jpg
   :align: center

.. image:: img/features/features3.jpg
   :align: center

Exporting as Spring archive (recommended)
-----------------------------------------

**Exporting your project using the "Spring archive" export option will include all features and is the recommended way to export a SpringBoard project.**

Export manually
---------------

Manual export is only recommended if you want to customize the export process (perhaps you want to compile the map yourself using a third-party tool).
In that case you can follow the below tutorial.

s11n export should be used if you want to export game objects (units, features, etc.) and load them in your standalone map.
{'fraction_non_alphanumeric': 0.12011173184357542, 'fraction_numerical': 0.004888268156424581, 'mean_word_length': 3.5332278481012658, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3682705', 'n_tokens_mistral': 729, 'n_tokens_neox': 708, 'n_words': 356}