Skip to content

Commit f5dc8be

Browse files
committed
Updated Documentation
1 parent e0470cc commit f5dc8be

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This is a project that, when finished, will allow for the creation of data packs
2828
- [ ] [default tags](#default-item-tags)
2929

3030
# How To Use
31-
Download both "main.py" and "tags.py" and put them in your chosen project root directory. Create a directory called "tags" (where your tags go) and create your files (files can be present in any subdirectory that does not have "." at the beginning of it). Copy the ".saved" directory into your root (you can delete any file that is in the "you can delete this" directory) In your "main.mcscript" file (create one if you don't have it; must be in root directory), add the following line to specify your pack details:
31+
Download both "main.py" and "tags.py" and put them in your chosen project root directory. Create a directory called "tags" (where your tags go) and create your files (files can be present in any subdirectory that does not have "." at the beginning of it). Copy the ".saved" directory into your root (you can delete any file that doesn't begin with "minecraft" in ".saved/tags") In your "main.mcscript" file (create one if you don't have it; must be in root directory), add the following line to specify your pack details:
3232

3333
pack-info: "[Pack name]" "[Pack ID (used for namespace)]" "[Pack description]" [Use snapshots (true or false)];
3434

@@ -169,18 +169,29 @@ The following information is stored for every entity in the ".saved/data/entity_
169169
|width|The witdth of the entities hitbox in blocks|decimal number
170170
|height|The height of the entities hitbox in blocks|decimal number
171171
|length|The height of the entities hitbox in blocks (for most entities this is eqwual to the width)|decimal number
172-
|volume|The total amount of space in blocks the entity takes up. Calculated using the formula "length \* width \* height"|decimal number
172+
|volume|The total amount of space in blocks the entity takes up. Calculated using the formula "length * width * height"|decimal number
173173
|health|The maximum amount of health points this entity can have. "n/a" for entities that do not have health.|n/a or integer
174-
|environment|The prefered environment for this entity|land, air, or water
174+
|environment|The preferred environment for this entity|land, air, or water
175175
|dimension|The dimension(s) this entity may be found naturally.|all, none, overworld, nether, end, or overworld/nether
176176

177177
# Default Entity Tags
178178
The following entity tags are implemented into Minecraft by default and provided in the ".saved/tags" directory of the generator:
179179
|name|contents|
180180
|--|--|
181-
|minecraft:arrows|arrow, spectral_arrow|
182-
|minecraft:beehive_inhabitors|bee|
183-
|minecraft:impact_projectiles|arrow, spectral_arrow, snowball, fireball, small_fireball, egg, trident, dragon_fireball, wither_skull|
184-
|minecraft:raiders|evoker, illusioner, pillager, ravager, vindicator, witch|
185-
|minecraft:skeletons|skeleton, stray, wither_skeleton|
186-
|minecraft:powder_snow_walkable_mobs|rabbit, endermite, silverfish|
181+
|arrows|arrow, spectral_arrow|
182+
|beehive_inhabitors|bee|
183+
|impact_projectiles|arrow, spectral_arrow, snowball, fireball, small_fireball, egg, trident, dragon_fireball, wither_skull|
184+
|raiders|evoker, illusioner, pillager, ravager, vindicator, witch|
185+
|skeletons|skeleton, stray, wither_skeleton|
186+
|powder_snow_walkable_mobs‌|rabbit, endermite, silverfish|
187+
188+
# Function Data
189+
Each function you create using mcscript files will be added to the ".saved/data/functions.csv" file. You can also define external functions to be included within your mcscript file using 'def {namespace}:{function name}" (WIP). The following information is stored:
190+
|key|description|possible values
191+
|--|--|--|
192+
|namespace|The namespace the entry is defined in.|string, no spaces or ":"|
193+
|name|The name of the function as well as the data pack path it is stored in.|string, no spaces|
194+
195+
196+
# Default Function Tags
197+
Minecraft doesn't implement functions by default, so there are no default tags for functions.

0 commit comments

Comments
 (0)