Skip to content

Commit 785e488

Browse files
committed
readme: format update & a new tip
1 parent 0932974 commit 785e488

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

ReadMe.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,34 @@ Use [Rojo](https://rojo.space/) to build the model from scratch.
44

55
An easy way is to [install Rojo on VS Code](https://rojo.space/docs/v7/getting-started/installation/).
66

7+
78
# About the Tool
89

10+
911
## Setting up the Tool
1012

1113
The tool requires certain instances to be moved into the containers of the [DataModel](https://create.roblox.com/docs/reference/engine/classes/DataModel).
1214

13-
Open the container scripts (`Heart Pie` > `ContainerScripts (see ReadMe)`) and follow the instructions in `ReadMe`.<br>
14-
When playtesting, there will be warnings in the output if the container scripts aren't correctly set up.
15+
Open the container scripts (`Heart Pie` > `ContainerScripts (see ReadMe)`) and follow the instructions in `ReadMe`.
16+
17+
> [!NOTE]
18+
>
19+
> When playtesting, there will be warnings in the output if the container scripts aren't correctly set up.
20+
21+
> [!TIP]
22+
>
23+
> You can also set up the tool using the [Pie Hiking Creation Kit](https://create.roblox.com/store/asset/18723187294/Pie-Hiking-Creation-Kit) plugin,
24+
> which also contains a kit for creating pie hiking maps!
25+
1526

1627
## Reference Properites
1728

1829
The project contains several [reference](https://rojo.space/docs/v7/properties/#ref) properties.<br>
1930
These are dynamically set through the [initializer](/src/Heart%20Pie/ToolScripts/-InitializerActor/Initializer.server.luau) and [PieSkins](./src/Heart%20Pie/ToolScripts/PieSkinsActor/ServerPieSkin.server.luau) script.
2031

21-
- SkinMainPart:
32+
- `SkinMainPart`:
2233
- RigidConstrant (PieSkinAttachment, PieAttachment)
23-
- MainPart:
34+
- `MainPart`:
2435
- AlignOrientation (PieAttachment)
2536
- RigidConstrant (PieRightGripAttachment, RightGripAttachment)
2637
- UpwardsForce (PieAttachment)
@@ -36,6 +47,7 @@ To set these properties in Roblox Studio:
3647

3748
The reason for the additional script is that [Rojo hasn't released full support for Ref properties](https://github.com/rojo-rbx/rojo/blob/7e2bab921aa71f76d07d0424e4bb4064e8b7c995/CHANGELOG.md) at this time.
3849

50+
3951
## Credits
4052

4153
Pie Skins:

0 commit comments

Comments
 (0)