Differences

This shows you the differences between two versions of the page.

--- housing-guide [2023/12/20 15:59] – [Table] msnaz
+++ housing-guide [2025/08/18 16:50] (current) – old revision restored (2024/01/04 16:32) grumpy
@@ Line 1: / Line 1: @@
+{{:housing.png?nolink|}}
 ==== Summary ====
 Housing offers the community a unique and creative experience in building and sharing their homes within the community. In this gamemode, players have the freedom to design and customize their houses using various in-game tools and resources. What sets this feature apart is the integration of a web application known as the Script Editor, allowing players not only to construct their homes but also to collaborate with friends in real-time.
@@ Line 8: / Line 10: @@
 ==== Rick ====
-Met Rick your house manager, he will facilitate your journey through the management of your houses.
+Meet Rick your house manager, he will facilitate your journey through the management of your houses.
-=== What can Rick does? ===
+----
-Rick helps you to manage your house, not only by giving you access to your houses settings, but also by providing items, blocks, armors, ...
+=== What can Rick do? ===
-He also have a way to toggle the scripts you created in case you want to make a script load only in a certain house. (Note that by default all scripts are enabled on all of your houses)
-=== How to use Rick ===
+Rick helps you manage your house, not only by giving you access to your house settings but also by providing items, blocks, armor, etc. He also has a way to toggle the scripts you created in case you want to make a script load only in a certain house. (Note that by default, all scripts are enabled on all of your houses)
-You can both click on the Rick's npc in the center of your house or use the **/rick** command.
+----
+=== How to use Rick ===
+You can either click on the Rick's npc in the center of your house or use the **/rick** command.
+----
 ==== Commands ====
 The housing experience is gui based, however there is a list of command you must know to enjoy your experience.
@@ Line 44: / Line 48: @@
 | /redo                                           | Redoes the last /undo command you made.                                                                           |
 | /rotate <x-rotation> <y-rotation> <z-rotation>  | Rotate your selection around x, y and z axis.                                                                     |
+| /moverick                                       | Moves Rick to your current position.                                                                              |
+| /getblock                                       | Get the block you are looking at.                                                                                 |
+| /furniture                                      | Opens the furniture menu.                                                                                         |
+| /blocks                                         | Open the blocks menu.                                                                                             |
+| /members                                        | Open members management menu.                                                                                     |
+| /biomes                                         | Open the biomes menu.                                                                                             |
+| /home                                           | Teleports you to the last house you were in. (Works only for your houses and the houses you're a member)          |
 ==== Scripts Editor ====
+The script editor provides a codeless experience to create scripts and quests to enhance your houses.
+----
+=== Create a session ===
+Creating an editor session is the first step you need to go through before creating or editing your scripts.
+In order to get a fresh session, execute /editor in housing. Rick will give you a link to the editor after a few seconds.
+----
+=== Templates ===
+We know creating a script from scratch for the first time can be really tricky, so to help you, we made 5 different templates that you can use as a reference to make your own scripts.
+See the section below to learn how to create your first script and how to use a template.
+----
+=== Create your first script ===
+Once you click the link Rick gave you, you will have the following modal popping up:
+{{ :housing-1.png?nolink |}}
+The first step is to choose a name for your script and type it in the modal,
+then click on the "Next" button.
+//Script name can only contains letters, dashes and underscores.//
+{{ :housing-2.png?nolink |}}
+The second and final step is to choose a template to start with, click on your preferred template, and click on the "Create" button.
+You're done! You can start editing your script and creating an awesome experience for the community.
+{{ :housing-3.png?nolink |}}
+----
+=== Toggle scripts ===
+Rick can help you with script management in-game. In order to toggle your scripts on each of your houses, open Rick's menu and go to the "Scripts" submenu.
+{{ :housing-4.png?nolink |}}
+You can toggle each script by clicking on the "On" and "Off" buttons. If you have more than six scripts, you can scroll by clicking on the top and bottom arrows.
+----
+=== Delete a script ===
+Deleting a script is really easy, you just need to click on the "Delete" button at the right of the top bar and wait a few seconds.
+{{ :housing-5.gif?nolink |}}
+----