Skip to content

Commit e819ad0

Browse files
committed
Add getting started section to README
1 parent 850d0ab commit e819ad0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

addons/block_code/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ Expressing an appropriate layer of abstraction is perhaps the most challenging a
1212

1313
That said, we are in no way opposed to having this project grow to be able to create more complex games, as long as it does not negatively affect the experience for learners.
1414

15+
# Getting Started
16+
17+
1. Install the plugin through the Godot AssetLib or clone the repository and drag the `addons/block_code/` directory into your project's `res://addons/` directory.
18+
19+
2. Make sure to enable the plugin in `Project > Project Settings > Plugins`
20+
21+
3. You're ready to get started! Open a scene, and add a `BlockCode` child node to any node in the scene using the `Add Child Node` menu dialog.
22+
23+
4. The Block Code editor will open in a new tab. Drag blocks from the picker and snap them together to create a script. You can switch to other Block Code scripts by clicking the respective `BlockCode` node in the scene tree.
24+
25+
5. Run the scene to see your Block Code scripts in action. Block Code scripts are attached to the `BlockCode` node's parent, and are saved to the scene.
26+
27+
1528
# Current status
1629

1730
We are nearing our initial milestone where simple games can be created with blocks. This is a kind of MVP demo which will then let us figure out our next steps.

0 commit comments

Comments
 (0)