✨ feat: add a new bs.string module

docs/modules.md

@@ -11,6 +11,7 @@ Bookshelf is designed with modularity in mind. Features that serve a common purp
 ## 🌟 Featured Modules
 
 ```{include} _templates/featured-modules.md
+
 ```
 
 ```{toctree}
@@ -39,6 +40,7 @@ modules/tree
 modules/vector
 modules/view
 modules/xp
+modules/string
 ```
 
 ```{toctree}

docs/modules/string.md

@@ -0,0 +1,100 @@
+# 🔠 String
+
+**`#bs.string:help`**
+
+---
+
+## 🔧 Functions
+
+You can find below all functions available in this module.
+
+---
+
+### Concat
+
+```{function} #bs.string:concat
+
+Merges a list of strings together into one string
+
+:Inputs:
+  **Storage `bs:in string.concat.list`**: {nbt}`string` The list of strings that will be merged.
+
+:Outputs:
+  **Storage `bs:out string.concat`**: {nbt}`string` The merged string.
+```
+
+_Merged Hello and World:_
+
+```mcfunction
+data modify storage bs:in string.concat.list set value ["Hello ","World"]
+
+function #bs.string:concat
+
+tellraw @a [{"text":"The merged string is \""},{"storage":"bs:out","nbt":"string.concat"},{"text":"\""}]
+```
+
+> **Credits**: Aure31
+
+---
+
+### Uppercase / Lowercase
+
+:::::{tab-set}
+::::{tab-item} Upper
+
+```{function} #bs.string:upper {type:<mode>}
+
+Converts the text to uppercase
+
+:Inputs:
+  **Storage `bs:in string.upper.str`**: {nbt}`string` The string to convert to uppercase
+
+  **Function Macro**:
+  :::{treeview}
+  - {nbt}`compound` Arguments
+   - {nbt}`string` **type** : the size of the character table (`fast` or `slow`)
+  :::
+
+:Outputs:
+  **Strorage `bs:out string.upper`**: {nbt}`string` The uppercase string
+```
+
+_put hello world to uppercase:_
+
+```mcfunction
+data modify storage bs:in string.upper.str set value "hello world"
+
+function #bs.string:upper {type:'fast'}
+
+tellraw @a [{"text":"The uppercase string is \""},{"storage":"bs:out","nbt":"string.upper"},{"text":"\""}]
+```
+
+::::
+::::{tab-item} Lower
+
+```{function} #bs.string:lower {type:<mode>}
+
+Converts the text to lowercase
+
+:Inputs:
+  **Storage `bs:in string.lower.str`**: {nbt}`string` The string to convert to lowercase
+
+  **Function Macro**:
+  :::{treeview}
+  - {nbt}`compound` Arguments
+   - {nbt}`string` **type** : the size of the character table (`fast` or `slow`)
+  :::
+
+:Outputs:
+  **Strorage `bs:out string.lower`**: {nbt}`string` The lowercase string
+```
+
+_put hello world to lowercase:_
+
+```mcfunction
+data modify storage bs:in string.lower.str set value "hello world"
+
+function #bs.string:lower {type:'fast'}
+
+tellraw @a [{"text":"The lowercase string is \""},{"storage":"bs:out","nbt":"string.upper"},{"text":"\""}]
+```

meta/manifest.json

@@ -3334,6 +3334,185 @@
         }
       ]
     },
+    {
+      "id": "bs.string",
+      "name": "String",
+      "slug": "bookshelf-string",
+      "readme": "https://raw.githubusercontent.com/mcbookshelf/Bookshelf/refs/heads/master/modules/bs.string/README.md",
+      "description": "Get information about the system string effortlessly.",
+      "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html",
+      "kind": "data_pack",
+      "tags": [
+        "default"
+      ],
+      "features": [
+        {
+          "id": "#bs.string:concat",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#concat",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/10",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/13",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:find",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#find",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/12",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:index_of",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#index-of",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2024/10/27",
+            "minecraft_version": "1.21.3"
+          },
+          "updated": {
+            "date": "2025/01/13",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:insert",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#find",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/25",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/25",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:lower",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#case",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/11",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/13",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:replace",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#replace",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:split",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#split",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:to_list",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#to_list",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:to_number",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#to_number",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/11",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:to_string",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#to_string",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/11",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/15",
+            "minecraft_version": "1.21.4"
+          }
+        },
+        {
+          "id": "#bs.string:upper",
+          "documentation": "https://docs.mcbookshelf.dev/en/latest/modules/string.html#case",
+          "authors": [
+            "aure31"
+          ],
+          "created": {
+            "date": "2025/01/11",
+            "minecraft_version": "1.21.4"
+          },
+          "updated": {
+            "date": "2025/01/13",
+            "minecraft_version": "1.21.4"
+          }
+        }
+      ]
+    },
     {
       "id": "bs.time",
       "name": "Time",

modules/bs.string/README.md

@@ -0,0 +1,9 @@
+# 🔠 Bookshelf String
+
+This module allows you to easily manage string in Minecraft.
+
+For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/string.html).
+
+## 📖 About Bookshelf
+
+This module is part of the [Bookshelf Project](https://docs.mcbookshelf.dev/en/latest/index.html), a modular library datapack designed to simplify complex systems in Minecraft. Explore the full range of modules and discover how Bookshelf can simplify your Minecraft creations!

modules/bs.string/data/bs.string/function/__load__.mcfunction

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2025 Gunivers
+#
+# This file is part of the Bookshelf project (https://github.com/mcbookshelf/Bookshelf).
+#
+# This source code is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Conditions:
+# - You may use this file in compliance with the MPL v2.0
+# - Any modifications must be documented and disclosed under the same license
+#
+# For more details, refer to the MPL v2.0.
+# ------------------------------------------------------------------------------------------------------------
+
+scoreboard objectives add bs.data dummy [{"text":"BS ","color":"dark_gray"},{"text":"Data","color":"aqua"}]
+scoreboard objectives add bs.out dummy [{"text":"BS ","color":"dark_gray"},{"text":"Output","color":"aqua"}]
+scoreboard objectives add bs.ctx dummy [{"text":"BS ","color":"dark_gray"},{"text":"Ctx","color":"aqua"}]
+scoreboard objectives add bs.const dummy [{"text":"BS ","color":"dark_gray"},{"text":"Const","color":"aqua"}]
+
+#set constant
+scoreboard players set 8 bs.const 8

modules/bs.string/data/bs.string/function/__unload__.mcfunction

@@ -0,0 +1,21 @@
+# ------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2025 Gunivers
+#
+# This file is part of the Bookshelf project (https://github.com/mcbookshelf/Bookshelf).
+#
+# This source code is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Conditions:
+# - You may use this file in compliance with the MPL v2.0
+# - Any modifications must be documented and disclosed under the same license
+#
+# For more details, refer to the MPL v2.0.
+# ------------------------------------------------------------------------------------------------------------
+
+scoreboard objectives remove bs.data
+scoreboard objectives remove bs.out
+scoreboard objectives remove bs.ctx
+
+#data remove storage bs:in string
+data remove storage bs:data string

modules/bs.string/data/bs.string/function/concat/binary.mcfunction

@@ -0,0 +1,7 @@
+execute if score #n bs.ctx matches 2048.. run function bs.string:concat/combine/2048
+execute if score #n bs.ctx matches 1024.. run function bs.string:concat/combine/1024
+execute if score #n bs.ctx matches 512.. run function bs.string:concat/combine/512
+execute if score #n bs.ctx matches 256.. run function bs.string:concat/combine/256
+execute if score #n bs.ctx matches 128.. run function bs.string:concat/combine/128
+execute if score #n bs.ctx matches 64.. run function bs.string:concat/combine/64
+say max

modules/bs.string/data/bs.string/function/concat/concat.mcfunction

@@ -0,0 +1,31 @@
+# ------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2025 Gunivers
+#
+# This file is part of the Bookshelf project (https://github.com/mcbookshelf/Bookshelf).
+#
+# This source code is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Conditions:
+# - You may use this file in compliance with the MPL v2.0
+# - Any modifications must be documented and disclosed under the same license
+#
+# For more details, refer to the MPL v2.0.
+# ------------------------------------------------------------------------------------------------------------
+
+# Modified from https://github.com/CMDred/StringLib/
+
+data modify storage bs:ctx _.s.1 set from storage bs:ctx _.list[-1]
+data remove storage bs:ctx _.list[-1]
+execute store result score #n bs.ctx run data get storage bs:ctx _.list
+
+# we dont need below 64 since it's already handled in a single cycle
+execute if score #n bs.ctx matches 64.. run function bs.string:concat/binary
+say Macros
+# if stuff remains
+execute store result storage bs:ctx x int 1 store result score #c bs.ctx run scoreboard players get #n bs.ctx
+scoreboard players remove #c bs.ctx 1
+# Which dispatch to call
+execute store result storage bs:ctx y int 1 run scoreboard players operation #c bs.ctx /= 8 bs.const
+
+execute if score #n bs.ctx matches 1.. run function bs.string:concat/macro with storage bs:ctx