Skip to content

Commit

Permalink
docs: 📝 Updated README links
Browse files Browse the repository at this point in the history
  • Loading branch information
Stoupy51 committed Nov 26, 2024
1 parent 8f0c6e4 commit aa1fc25
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
26 changes: 13 additions & 13 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Toutes les 5 secondes, la librairie exécute à l'emplacement de chaque joueur l
### `#smart_ore_generation:v1/denied_dimensions`
* 🔍 Ce function tag est appelé lorsque la librairie veut scanner une région. Vous pouvez ajouter quelles dimensions que vous voulez empêcher d'être scannées en ajoutant une fonction à ce tag.
* 📝 Pour utiliser ce signal, vous devez ajouter une fonction à la liste de tags située dans `data/smart_ore_generation/tags/function/v1/signals/denied_dimensions.json`.
* 📖 Reportez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/denied_dimensions.mcfunction).
* 📖 Reportez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/denied_dimensions.mcfunction).
```mcfunction
#> smart_ore_generation:v1.5.0/signals/denied_dimensions
#> smart_ore_generation:v1.7.0/signals/denied_dimensions
#
# @within #smart_ore_generation:v1/signals/denied_dimensions
# @executed as & at le joueur qui a déclenché le signal
Expand All @@ -67,9 +67,9 @@ execute if score #authorized smart_ore_generation.data matches 1 if dimension mi
### `#smart_ore_generation:v1/generate_ores`
* 🔍 Ce function tag est appelé lorsque la librairie veut générer des minerais dans une région. Vous pouvez ajouter votre propre fonction de génération de minerai à ce tag.
* 📝 Pour utiliser ce signal, vous devez ajouter une fonction à la liste de tags située dans `data/smart_ore_generation/tags/function/v1/signals/generate_ores.json`.
* 📖 Référez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/generate_ores.mcfunction)
* 📖 Référez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/generate_ores.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/generate_ores
#> smart_ore_generation:v1.7.0/signals/generate_ores
#
# @within #smart_ore_generation:v1/signals/generate_ores
# @executed as un marker spécial & at une position dont vous ne devriez pas vous soucier
Expand All @@ -89,19 +89,19 @@ execute if predicate simplenergy:in_overworld run scoreboard players set #dimens
# Generate Simplunium Ore (x4) in the overworld only
scoreboard players operation #min_height smart_ore_generation.data = _OVERWORLD_BOTTOM smart_ore_generation.data
scoreboard players set #max_height smart_ore_generation.data 40
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
# Voir le modèle dans le lien pour le contenu de la fonction smart_ore_generation:v1.5.0/signals/example/simplunium_ore.mcfunction
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
# Voir le modèle dans le lien pour le contenu de la fonction smart_ore_generation:v1.7.0/signals/example/simplunium_ore.mcfunction
```

### `#smart_ore_generation:v1/post_generation`
* 🔍 Ce function tag est appelé lorsque la librairie a fini de générer des minerais dans les régions. Vous pouvez ajouter votre propre fonction de post-génération à ce tag.
* 📝 Pour utiliser ce signal, vous devez ajouter une fonction à la liste de tags située dans `data/smart_ore_generation/tags/function/v1/signals/post_generation.json`.
* 📖 Référez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/post_generation.mcfunction)
* 📖 Référez-vous à ce modèle pour le contenu de la fonction [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/post_generation.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/post_generation
#> smart_ore_generation:v1.7.0/signals/post_generation
#
# @within #smart_ore_generation:v1/signals/post_generation
# @executed as none at none (default of a /schedule)
Expand Down Expand Up @@ -131,9 +131,9 @@ execute if score #generated_deepslate_ore simplenergy.data matches 1 run scorebo

### `#smart_ore_generation:v1/slots/random_position`
* 🎲 Ce function tag doit être appelé lorsque vous avez besoin d'une position aléatoire dans la région.
* 📖 Pour utiliser correctement ce slot, voir le modèle [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/simplunium_ore.mcfunction)
* 📖 Pour utiliser correctement ce slot, voir le modèle [ici](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/simplunium_ore.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/example/simplunium_ore
#> smart_ore_generation:v1.7.0/signals/example/simplunium_ore
#
# @example from SimplEnergy datapack
# Exemple de comment trouver une position aléatoire dans une région pour générer un minerai
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Every 5 seconds, the library run at the location of every player the following s
### `#smart_ore_generation:v1/denied_dimensions`
* 🔍 This function tag is called when the library want to scan a region. You can add which dimension you want to deny from being scanned by adding a function to this tag.
* 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/denied_dimensions.json`.
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/denied_dimensions.mcfunction).
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/denied_dimensions.mcfunction).
```mcfunction
#> smart_ore_generation:v1.5.0/signals/denied_dimensions
#> smart_ore_generation:v1.7.0/signals/denied_dimensions
#
# @within #smart_ore_generation:v1/signals/denied_dimensions
# @executed as & at the player who triggered the event
Expand All @@ -67,9 +67,9 @@ execute if score #authorized smart_ore_generation.data matches 1 if dimension mi
### `#smart_ore_generation:v1/generate_ores`
* 🔍 This function tag is called when the library want to generate ores in a region. You can add your own ore generation function to this tag.
* 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/generate_ores.json`.
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/generate_ores.mcfunction)
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/generate_ores.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/generate_ores
#> smart_ore_generation:v1.7.0/signals/generate_ores
#
# @within #smart_ore_generation:v1/signals/generate_ores
# @executed as a special marker & at a position you shouldn't care about
Expand All @@ -89,19 +89,19 @@ execute if predicate simplenergy:in_overworld run scoreboard players set #dimens
# Generate Simplunium Ore (x4) in the overworld only
scoreboard players operation #min_height smart_ore_generation.data = _OVERWORLD_BOTTOM smart_ore_generation.data
scoreboard players set #max_height smart_ore_generation.data 40
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.5.0/signals/example/simplunium_ore
# See the template in the link for the content of the function smart_ore_generation:v1.5.0/signals/example/simplunium_ore.mcfunction
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.0/signals/example/simplunium_ore
# See the template in the link for the content of the function smart_ore_generation:v1.7.0/signals/example/simplunium_ore.mcfunction
```

### `#smart_ore_generation:v1/post_generation`
* 🔄 This function tag is called when the library has finished generating ores in regions. You can add your own post-generation function to this tag.
* 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/post_generation.json`.
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/post_generation.mcfunction)
* 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/post_generation.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/post_generation
#> smart_ore_generation:v1.7.0/signals/post_generation
#
# @within #smart_ore_generation:v1/signals/post_generation
# @executed as none at none (default of a /schedule)
Expand Down Expand Up @@ -130,9 +130,9 @@ execute if score #generated_deepslate_ore simplenergy.data matches 1 run scorebo
## 📤 <ins>Slots</ins>
### `#smart_ore_generation:v1/slots/random_position`
* This function tag should be called when you need a random position in the region.
* To use properly this slot, see the template [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.5.0/signals/example/simplunium_ore.mcfunction)
* To use properly this slot, see the template [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.0/signals/example/simplunium_ore.mcfunction)
```mcfunction
#> smart_ore_generation:v1.5.0/signals/example/simplunium_ore
#> smart_ore_generation:v1.7.0/signals/example/simplunium_ore
#
# @example from SimplEnergy datapack
# Always launch the random position function tag before anything else
Expand Down

0 comments on commit aa1fc25

Please # to comment.