Skip to content

Commit 36195d8

Browse files
committed
more polish
1 parent f23789a commit 36195d8

File tree

4 files changed

+34
-8
lines changed

4 files changed

+34
-8
lines changed

static/assets/pages/building.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Booth Building
22

3+
##### **Booths** are themed builds that tourists can explore, that also showcase a modding project!<br/>
34
##### Want something visual? Check out some [build examples](/pages/examples).
45

56
---
67

7-
## Booth Guidelines
8+
## Booth Structure
89

9-
**Booths** are themed builds that tourists can explore, that also showcase a modding project!<br/>
1010
Your average booth showcases a mod, and contains:
1111
- An entrance along a tourist path with a large sign displaying the name of the mod.
1212
- One collectible **Visitor Shard** ([Scattered Shards](https://modrinth.com/mod/scattered-shards)) placed at the start of the booth.

static/assets/pages/claiming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To make the map digestible for tourists, we use one key concept: **Booths are l
2525
- Booth entrances are on these paths OR on a shorter with multiple booths connecting to the main path.
2626
- Effectively, booths have a "street" (path), "number" (district spot), and maybe "unit" (short path spot)
2727

28-
This breaks up touring into completable parts (districts), and let you tour them like doing a paper round!
28+
This breaks up touring into completable parts (districts), and lets you tour them like a paper round!
2929

3030
---
3131

static/assets/pages/debugging.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,27 @@
44

55
---
66

7-
## Bug Isolation & Bisecting
7+
## Bug Triage
88

9-
---
9+
When you encounter a crash or serious bug, you should first **upload your `.minecraft/logs/latest.log` to [mclo.gs](https://mclo.gs)**. You can then:
10+
- Search to see if there are related errors in the log (near the bottom!)
11+
- Check the bug thread to see if there are any issues that match
12+
- Create a thread tagged `Not Isolated`, unless you already know the culprit mod
13+
14+
Once the culprit mod is identified, the tag can be swapped to `Isolated` and the authors pinged.
15+
16+
You **don't need to stop here** - you're welcome to open up the source code and identify the fix - PR it if you like!
1017

11-
## Mod Stability - Dos and Don'ts
18+
Once the fix has been verified and released in a new version of the mod, the tag can be swapped to `Solved`.
1219

1320
---
1421

1522
## Profiling & Optimization
1623

17-
---
24+
To validate the performance of your mod, we recommend running [spark](https://modrinth.com/mod/spark).
25+
26+
For the simplest usage, simply:
27+
28+
- open a world and run `spark profiler start` / `sparkc profiler start`
29+
- create a bunch of interactions with your mod (e.g. spawn 100 of your entities, use an item a lot of times, place lots of your blocks)
30+
- run `spark profiler stop` / `sparkc profiler stop` and review the results for anything concerning.

static/assets/pages/modding.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,17 @@ It's minimal, but helps out with establishing some good practices like:
1717

1818
If you're new to modding, we highly recommend it, as it'll help you meet our submission requirements.
1919

20-
If you're already experienced, feel free to use it as a reference! You might find something new.
20+
If you're already experienced, feel free to use it as a reference! You might find something new.
21+
22+
---
23+
24+
## [Item Descriptions](https://github.com/cassiancc/Item-Descriptions)
25+
26+
Event packs ship with the ability to add explanatory tooltips to your items!
27+
```json
28+
"lore.minecraft.lightning_rod": "A block that prevents your builds from being struck by Lightning by attracting nearby bolts."
29+
```
30+
31+
This helps explain the usage of items to all players, not just those visiting your booth later.
32+
33+
---

0 commit comments

Comments
 (0)