Skip to content

Commit 45f5c6d

Browse files
committed
Updated documentation
1 parent 0f9d1b0 commit 45f5c6d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
This is a project that, when finished, will allow for the creation of data packs and data pack tags through a simple programming language syntax that resembles object oriented languages such as Java. This is intended to be much more powerful and user friendly than typing a series of commands like you do in regular development. Here are the planned features (checked features are implemented, while unchecked are works in progress):
44

5+
- [x] [Basic Use](#how-to-use)
56
- [x] Tag Development
67
- [x] [Define a tag](#define-a-tag)
78
- [x] [Add entries to your tag](#add-entries)
@@ -26,6 +27,15 @@ This is a project that, when finished, will allow for the creation of data packs
2627
- [ ] [items](#item-data)
2728
- [ ] [default tags](#default-item-tags)
2829

30+
# 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). 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:
32+
33+
pack-info: "[Pack name]" "[Pack ID (used for namespace)]" "[Pack description]" [Use snapshots (true or false)];
34+
35+
Run the "main.py" file using python 3.8.2 (the version this was developed in), and your data pack will be created in ".generated/packs/{pack_name}". You can copy-paste the entire folder to your world's data pack directory and your data pack should load without problems (unless you have a syntax error in one of your literal commands).
36+
37+
Currently, only tags will be generated based on input, while the functions will be populated by generic statements.
38+
2939
# Define a Tag
3040
You may define a tag by creating a file with the "mctag" extension in the directory "./tags" relative to the main directory (the directory where you put "main.py" and "tags.py"). All subdirectories of "./tags" will be checked for files, and the resulting data pack will preserve subdirectories (so if you put a file in the "internal" folder, the tag name will be "#internal/[tag_name]").
3141

@@ -162,4 +172,4 @@ The following information is stored for every entity in the ".saved/data/entity_
162172
|volume|The total amount of space in blocks the entity takes up. Calculated using the formula "length * width * height"|decimal number
163173
|health|The maximum amount of health points this entity can have. "n/a" for entities that do not have health.|n/a or integer
164174
|environment|The prefered environment for this entity|land, air, or water
165-
|dimension|The dimension(s) this entity may be found naturally.|all, none, overworld, nether, end, or overworld/nether
175+
|dimension|The dimension(s) this entity may be found naturally.|all, none, overworld, nether, end, or overworld/nether

0 commit comments

Comments
 (0)