Guild of Writers

{{Tutorial}}

In this tutorial, we’ll set up a local testing shard for Myst Online: Uru Live fan Ages using the H’uru client and DIRTSAND server software. This local shard allows you to test your Ages swiftly and independently, without needing to submit files to a shard operator and wait for feedback. Since the server is running on your computer, you’ll have immediate access to the results of your work.

== Minimum Requirements ==
A computer with Windows 10 version 2004 or newer. To check your version:
# Press the <code>Win+R</code> keys on your keyboard to open the Run dialog.
# Type <code>winver</code> and press Enter.
# A window will appear displaying your current Windows version. Ensure that it is version 2004 or newer. If not, please update your operating system before proceeding.


== Prerequisites ==
Before starting the actual setup, ensure that your system meets the minimum requirements and that the necessary tools and software are installed.


=== Git Installation ===
# Download Git from its [https://git-scm.com/download/win official download page].
# Run the downloaded file and follow the installation wizard.


=== Windows Terminal Installation ===
# Open Microsoft Store on your computer.
# Search for “Windows Terminal”.
# Select it from the list and click “Install”.


=== Docker Desktop and WSL2 Installation ===
# Download Docker Desktop from [https://www.docker.com/products/docker-desktop Docker’s official page].
# Install Docker Desktop, enabling WSL 2 features during installation.


== Setup Working Directory ==
A dedicated workspace on your desktop will help organize the files and applications needed for the server setup and testing process efficiently.
# On your desktop, right-click on an empty space. 
# In the context menu, hover over “New”, then select “Folder” from the sub-menu that appears.
# A new folder will be created.
# Right click on the new folder and rename it to <code>dockersand</code>.


== Download H’uru Client ==
# Go to [https://github.com/H-uru/Plasma/releases H’uru’s GitHub releases page].
# For 32-bit Windows, download <code>plasma-windows-x86-internal-release.zip</code>. For 64-bit Windows, download <code>plasma-windows-x64-internal-release.zip</code>.
# Locate the downloaded zip file, usually in the Downloads folder.
# Right-click on the zip file and select “Extract All…”.
# In the pop-up window, click “Browse”, navigate to the Desktop and select the <code>dockersand</code> folder. Click “Select Folder”, then “Extract”.


== Download Game Data ==
This section guides you through acquiring the necessary H’uru data files for the game. These files are essential for the game to run properly. Using the correct version ensures compatibility with the H’uru client.

* On your desktop, open the <code>dockersand</code> folder.
* Inside the <code>dockersand</code> folder, right-click on an empty space and select “Open in Windows Terminal”.
* In the terminal, type and enter the following commands, pressing Enter after each:
<pre>git clone --sparse https://github.com/H-uru/moul-assets.git
cd moul-assets
git sparse-checkout set compiled</pre>

* In the terminal, type and enter the following commands, pressing Enter after each:
<pre>cd ..
cd client
mklink /J avi ..\moul-assets\compiled\avi
mklink /J dat ..\moul-assets\compiled\dat
mklink /J sfx ..\moul-assets\compiled\sfx</pre>


== Build Dirtsand Test Server ==
In this section, we will set up the Dirtsand server. This server is necessary to test your Ages on your computer. Follow the steps below to get the server ready.

# On your desktop, find and open the <code>dockersand</code> folder.
# Within the <code>dockersand</code> folder, you will find a folder named <code>dirtsand</code>. Open it.
# Once inside the <code>dirtsand</code> folder, right-click on an empty space and from the context menu, select “Open in Terminal”. This will open a terminal window focused on the <code>dirtsand</code> folder.
# Now, in the terminal, you need to type a command to build the server. Simply type <code>./dockersand build</code> and then press the Enter key on your keyboard. This action will initiate the building process of the server. Wait for it to complete.

== Linking Age and SDL Files ==
To ensure both the server and client use the same versions of the <code>.age</code> and <code>.SDL</code> files, we’ll link them from the game client to the server. This step makes sure that as you create and edit Ages, the changes are reflected in both the server and client.
# On your desktop, open the <code>dockersand</code> folder. 
# Inside, open the <code>dirtsand</code> folder.
# Now right-click anywhere inside the <code>dirtsand</code> folder and select “Open in Terminal” from the context menu. 
# In the Terminal that appears, type <code>mklink /J SDL ..\..\client\SDL</code> and then press Enter. 
# Next, type <code>mklink /J dat ..\..\client\dat</code> and press Enter.


== Starting the Server ==
You must start the DirtSand server before you can test your Ages. This section will show you how to start DirtSand. 
# Open the <code>dockersand</code> folder on your desktop. 
# Inside the <code>dockersand</code> folder, find and open the <code>dirtsand</code> folder.
# Within <code>dirtsand</code>, right-click in an empty space and select “Open in Terminal”. 
# In the Terminal window, type <code>./dockersand start</code> and press Enter. This command will start the server.
# Remember, if you make changes to any <code>.age</code> or <code>.SDL</code> files, you’ll need to restart the server to apply those changes.
#* To restart the server, type <code>./dockersand restart</code> in the Terminal and press Enter.


== Configure Game Client ==
The game needs to know how to connect to your local testing server. This section will guide you through that process.
# Open the <code>dockersand</code> folder on your desktop, then open the <code>dirtsand</code> folder, followed by the <code>build</code> folder. 
# Inside, open the <code>etc</code> folder.
# Find the <code>server.ini</code> file, right-click on it, and choose “Copy”.
# Navigate back to the <code>client</code> folder within the <code>dockersand</code> folder on your desktop and paste the <code>server.ini</code> file there.


== Create Account ==
This section will walk you through creating an account your local DirtSand server so that you can log in with the game client. 
# Open the <code>dockersand</code> folder on your desktop and open the <code>dirtsand</code> folder inside it. Right-click within this folder and select “Open in Terminal”.
# Type <code>./dockersand attach</code> and press Enter.
# In the Dirtsand console, type <code>addacct &lt;username&gt; &lt;password&gt;</code> (replace <code>&lt;username&gt;</code> and <code>&lt;password&gt;</code> with your chosen username and password) and press Enter to create your account.


== Preparing the Game Shortcut ==
To run the game using local data files, we need to create a shortcut with special commands. 
# Open the <code>dockersand</code> folder on your desktop and find the <code>plClient.exe</code> file.
# Right-click <code>plClient.exe</code> and select ‘Create shortcut’.
# Right-click on the created shortcut and select ‘Properties’.
# In the ‘Target’ field, append <code>/LocalData</code> at the end of the existing text.
# Click ‘OK’ to save changes. Now you have a shortcut that will run the game using local data files.


== Running the Game ==
This section guides you through starting the game and connecting to your local testing shard. Ensure that Dockersand is running when you try to play the game.
# Find and double-click the “Start Uru” shortcut to launch the game.
# Once the game launches, enter the <code>&lt;username&gt;</code> and <code>&lt;password&gt;</code> you created earlier. 
# Press the “Login” button. The game client should now log in to your local DirtSand server, and you should now be able to play Uru.


== Shutting Down the Server ==
When you are finished testing, you might want to shut down Dockersand to conserve system resources. 
# Open the <code>dockersand</code> folder on your desktop. 
# Inside, open the <code>dirtsand</code> folder. 
# Right-click within the folder and select “Open in Terminal”. 
# In the terminal, type <code>./dockersand stop</code> and press Enter to stop Dockersand.