Skip to content

Commit 516f873

Browse files
LarsMans64LarsMans64
committed
Finish docs
1 parent 5ed34ae commit 516f873

16 files changed

Lines changed: 285 additions & 27 deletions

‎README.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
1-
---
2-
icon: /assets/logo.png
1+
# Team Diopside Docs
32

4-
meta:
5-
title: "Welcome! | Team Diopside Docs"
6-
---
3+
This is the repository for our [Documentation website](https://docs.teamdiopside.nl).
74

8-
# Team Diopside Documentation
9-
10-
Welcome to the Team Diopside Docs!
11-
12-
[!ref icon="/assets/seamless.png"](/seamless)
13-
14-
[!ref icon="/assets/separated-leaves.png"](/separated-leaves)
5+
The pages are made using [Retype](https://retype.com/).

‎assets/title.png‎

182 KB
Loading

‎index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
icon: /assets/logo.png
3+
4+
meta:
5+
title: "Welcome! | Team Diopside Docs"
6+
---
7+
8+
# Team Diopside Documentation
9+
10+
Welcome to the Team Diopside Docs!
11+
12+
[!ref icon="/assets/seamless.png"](/seamless)
13+
14+
[!ref icon="/assets/separated-leaves.png"](/separated-leaves)

‎seamless/creating.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ For example, such a folder structure could be `assets/supplementaries/seamless_r
1313

1414
!!!
1515
Don't know what the mod ID is? Look at the text before the ":" when hovering over the item with Advanced Tooltips enabled.
16-
!!!
16+
!!!

‎seamless/done.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
order: F
3+
icon: checkbox
4+
---
5+
6+
# Done
7+
8+
If you did everything correctly, your files should show up in the logs when starting Minecraft or reloading with F3+T.
9+
10+
If the rules don't work, your logs should contain error messages describing what went wrong and where. Good luck!
11+
12+
***If you end up making a pack, please let us know! We could include it in the mod :)***
13+
14+
[!ref icon="/assets/logo.png"](/)

‎seamless/examples.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
order: D
3+
icon: light-bulb
4+
---
5+
6+
# Examples
7+
8+
Some examples for reference
9+
10+
## Beds
11+
12+
Let's take a look at how you would create an outline rule for beds.
13+
14+
A bed has the parts `foot` and `head`. Both parts face the same direction. So, for the foot we need to connect to where it's facing, and for the head in the opposite direction.
15+
16+
```json bed_foot.json
17+
{
18+
"blocks": ["#minecraft:beds"],
19+
"blockstates": {
20+
"part": ["foot"]
21+
},
22+
"directions": ["/state:facing"],
23+
"connecting_blocks": ["/same"],
24+
"connecting_blockstates": {
25+
"facing": ["/same"],
26+
"part": ["/!same"]
27+
}
28+
}
29+
```
30+
31+
```json bed_head.json
32+
{
33+
"blocks": ["#minecraft:beds"],
34+
"blockstates": {
35+
"part": ["head"]
36+
},
37+
"directions": ["/state:facing+opposite"],
38+
"connecting_blocks": ["/same"],
39+
"connecting_blockstates": {
40+
"facing": ["/same"],
41+
"part": ["/!same"]
42+
}
43+
}
44+
```
45+
46+
Because we use a tag in `blocks`, beds from other mods would automatically work too, provided that the mod developer has added their beds to the tag.
47+
48+
## Chests
49+
50+
If a chest is large, it has the types `left` and `right`. Both blocks face in the same direction. If a left chest faces north, the right chest would be to the east, so rotating clockwise once. The Ender Chest is included in the tag but does not have a double variant, so we should exclude it.
51+
52+
```json chest_left.json
53+
{
54+
"blocks": ["#c:chests", "#forge:chests", "!minecraft:ender_chest"],
55+
"blockstates": {
56+
"type": ["left"]
57+
},
58+
"directions": ["/state:facing+1"],
59+
"connecting_blocks": ["/same"],
60+
"connecting_blockstates": {
61+
"facing": ["/same"],
62+
"type": ["right"]
63+
}
64+
}
65+
```
66+
67+
For right chests facing north, the left one would be in the west direction, so three clockwise rotations.
68+
69+
```json chest_right.json
70+
{
71+
"blocks": ["#c:chests", "#forge:chests", "!minecraft:ender_chest"],
72+
"blockstates": {
73+
"type": ["right"]
74+
},
75+
"directions": ["/state:facing+3"],
76+
"connecting_blocks": ["/same"],
77+
"connecting_blockstates": {
78+
"facing": ["/same"],
79+
"type": ["left"]
80+
}
81+
}
82+
```

‎seamless/files.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
order: B
3+
icon: file-code
4+
---
5+
6+
# Files
7+
8+
Inside of the folder you just created, we are going to add JSON files for different outline rules. These rules define how outlines of different blocks merge if they are next to each other.
9+
10+
An outline rule in its simplest form looks like this:
11+
12+
```json /minecraft/seamless_rules/sunflower.json
13+
{
14+
"blocks": ["minecraft:sunflower"],
15+
"directions": ["up", "down"],
16+
"connecting_blocks": ["minecraft:sunflower"]
17+
}
18+
```
19+
20+
- First we have the `blocks` list. This is where you put all blocks (or tags) that apply to this rule. Think of this as the block you are looking at.
21+
- The `connecting_blocks` list specifies which blocks (or tags) should be able to connect with the blocks in the `blocks` list.
22+
- The `directions` list contains all directions in which the rule should work. This can be `north`, `east`, `south`, `west`, `up` and `down`.
23+
24+
The file name can be whatever you want, but it would make sense to describe the rule.
25+
26+
## Blockstates
27+
28+
Optionally, you can specify blockstates too:
29+
30+
```json /minecraft/seamless_rules/door_upper.json
31+
{
32+
"blocks": ["#minecraft:doors"],
33+
"blockstates": {
34+
"half": ["upper"]
35+
},
36+
"directions": ["down"],
37+
"connecting_blocks": ["#minecraft:doors"],
38+
"connecting_blockstates": {
39+
"half": ["lower"]
40+
}
41+
}
42+
```
43+
44+
This means: any block in `#doors` with a state of `upper` for the property `half`, will connect to any block in `#doors` with a state of `lower` for the property `half`.
45+
46+
You can specify more than one state too, for example:
47+
48+
```json
49+
"blockstates": {
50+
"age": ["0", "1", "2"],
51+
"half": ["lower"]
52+
}
53+
```
54+
55+
!!!
56+
Creating these files can get quite time consuming, so the next page lists some shortcuts you can use.
57+
!!!
58+
59+
## Recursion
60+
61+
When looking at a block and a match is found, Seamless will check the connecting block for other connecting blocks. This could go on forever! Keep this in mind, as you will often need to create outline rules that are more specific, to keep the outlines from spreading to disconnected blocks.

‎seamless/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ expanded: true
77

88
Configure your own outlines by creating a simple resource pack for Seamless!
99

10-
10+
[!ref icon="/assets/logo.png"](/)

‎seamless/outline-rules.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎seamless/overriding.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
order: E
3+
icon: move-to-bottom
4+
---
5+
6+
# Overriding
7+
8+
It is very simple to override any built-in outline rule. You just have to create a file with the same name and in the same folders as the file you want to override and put your resource pack above the built-in one.
9+
10+
!!!
11+
You can view the files of the built-in resource pack on [GitHub](https://github.com/TeamDiopside/Seamless/tree/latest/fabric/src/main/resources/resourcepacks/default_seamless/assets).
12+
!!!

0 commit comments

Comments
 (0)