Windows Legacy Setup

Setup legacy private server on windows

Introduction

Welcome to the setup guide for legacy private servers. This guide is for the windows operating system. This guide will explain local setup for windows, that means nobody except you will able to play. If you wish to create a private server for everybody to play, please refer to our Ubuntu setup guide.

Requirements

  • A windows computer with at least 1GB of RAM
    • This tutorial is specifically for Windows 10, but the process is the same for all versions of Windows.
  • An internet connection
  • Ability to breathe

Setup

Install XAMPP

First, you will need to install XAMPP, this is an installer for Apache, PHP and MariaDB, which are all required by Houdini. This process is very simple, download the installer and execute it.

Go to the Apache Friends homepage and click “XAMPP for Windows” button to download the latest version.

Windows XAMPP Download

Click “Run” and the installer should execute.

If you get a message about User Account Control (UAC) being activated, just click “OK” to continue.

When the installer starts, click “Next” to move to the “Select Components” section of the installer.

Windows XAMPP Components

You will see that all of the components are checked, you may continue with all of them, but the only components required for this tutorial are Apache, PHP, MySQL & PHPMyAdmin. You may uncheck the rest of the components as they are not required.

You may now click “Next” until the installer starts.

Windows XAMPP Install

Finally, click “Finish” to exit the installer and open the XAMPP control panel. You may minimize the XAMPP control panel as you do not need it for now.

Install Redis

Redis is required to use Houdini. Installing Redis is very easy, just download the installer and execute it.

Windows Redis install

When asked if you wish to add the Redis installation folder to the PATH environment variable, you may want to check this as it can make debugging issues easier later on.

If you require a 32-bit Windows installer for Redis, you can find them here.

Leave all other settings in the installer the same, just click “Next” until the installation starts. Finally, click “Finish” to exit the installer.

Install Python

In order to run Houdini, you will need to install Python 2.7. This is very easy, just download the MSI installer and execute it.

Do not install Python 3.x! It will not work with Houdini as it does not yet support Python 3. You must use Python 2.7. At the time of writing this, the latest version of Python 2 is Python 2.7.15.

Windows Python download

When the install starts, click “Next” until you get to the “Customize Python” section of the installer. Scroll to the bottom of the list and find “Add python.exe to PATH”, click the drop down menu to the left and change the selected option to “Will be installed on local hard drive”.

Windows Python install

Finally, click “Next” and wait for the installer to finish, click “Finish” to exit the installer.

Setup media server

You can download a pre-configured media server from the Icerink archive here.

It may take a while to download depending on your internet connection.

Whilst the media is downloading, you will need to go and configure local subdomains for Apache. You may already have the XAMPP control panel open, if not, open the Windows start menu and search “XAMPP Control Panel”, to bring up the XAMPP control panel.

Apache config

Next, go to the control panel, click the “Config” button next to “Apache” and go to “<Browse> [Apache]”. Go to folder conf then extra and open file httpd-vhosts.conf with Notepad.

Apache vhosts

Paste the following at the bottom of the file.

<VirtualHost *:80>
    ServerAdmin webmaster@play.localhost
    DocumentRoot "C:/xampp/htdocs/play"
    ServerName play.localhost
    ErrorLog "logs/play.localhost-error.log"
    CustomLog "logs/play.localhost-access.log" common
</VirtualHost>

<VirtualHost *:80>
    ServerAdmin webmaster@media.localhost
    DocumentRoot "C:/xampp/htdocs/media"
    ServerName media.localhost
    ErrorLog "logs/media.localhost-error.log"
    CustomLog "logs/media.localhost-access.log" common
</VirtualHost>

Save the file and close Notepad.

Apache vhosts save

Go to the Windows start menu and search for “Notepad”, right click the Notepad application and select “Run as administrator”.

Windows notepad search

In notepad, click “File” and then “Open” (or just press Ctrl + O). You should see an explorer window open at C:/Windows/System32, inside this folder, go to drivers and then etc. Double click on file hosts to open it.

Notepad hosts

If you do not see any files in the explorer window after navigating to drivers and then etc, you probably need to change file type in windows explorer from “Text Documents” to “All Files”.

Notepad file type

Paste the following at the bottom of the file.

127.0.0.1	play.localhost
127.0.0.1	media.localhost

Save the file and close Notepad.

Hosts save

Now, go back to the XAMPP control panel and click the “Explorer” button.

XAMPP Explorer

Now go to the folder htdocs and delete all of the contents. You can drag-highlight them all, right click and then “Delete” or Ctrl + A, right click and then “Delete”.

htdocs delete

Your htdocs folder should now be empty.

Open a new explorer window and navigate to where you saved your Icerink media server you downloaded at the beginning of this step. Double click the media.zip file you downloaded.

Highlight the two folders inside play and media and drag them over to the htdocs explorer window.

extract media

The files will now extract, this may take a short while, you may continue with the tutorial whilst this completes, you are finished with this step.

Install Houdini

Now you will need to setup Houdini, this is the super-special magic sauce that allows your Club Penguin private server to function! Go to the Houdini GitHub repository and click “Clone or download”, then click “Download ZIP” to download Houdini as a ZIP archive.

If you have git installed on your Windows computer, you may open a command prompt and clone the repository.

git clone https://github.com/solero/houdini

If not, ignore this box!

Houdini save

You may save Houdini wherever you like, for this tutorial, Houdini will be saved on the windows desktop.

Go to where you saved the Houdini ZIP archive from GitHub, and extract it.

extract houdini

Open the folder you just extracted. Inside should be a folder which looks like this.

houdini folder

Hold down Shift on your keyboard and right click in the explorer window displaying the files shown above, in the context menu, click on “Open command window here”.

open command prompt

On newer versions of Windows 10, you may see “Open PowerShell here” instead of “Open command window here”, this is fine, PowerShell can act as a replacement for command prompt.

Make sure you are holding Shift when you right click! Otherwise you will not see the option.

When the command prompt (or PowerShell) window opens up, enter the following command and press enter.

pip install -r requirements.txt

You should see all of Houdini’s requirements install.

requirements install

At the end you should see a message similar to this.

Successfully installed Automat-0.7.0 PyHamcrest-1.9.0 PyYAML-3.13 SQLAlchemy-1.2.2 Twisted-18.7.0 ...

You may also see messages about the pip version being out of date, this is fine. If you see any errors (commonly shown in red) then you may need to ask for help on the forums.

Start Apache and MySQL service

Now you will need to start both the Apache and MySQL service. Go back to the XAMPP control panel.

Windows XAMPP control

Click “Start” next to both Apache and MySQL. Afterwards, the control panel should look similar to above (Apache & MySQL both in green highlight). Finally, you may now close the XAMPP control panel.

Setup the database

Open a web browser and navigate to http://localhost/phpmyadmin. You should see the PHPMyAdmin interface.

Click “New” above the list of databases.

phpmyadmin

Enter “Houdini” in “Database name” entry field and click “Create”.

create database

Now click “Import” along the top pane and then “Browse”.

database browse

An explorer window should appear, browse to where you extracted Houdini, and find the houdini.sql file inside, select that file and click “Open”.

sql install

Scroll to the bottom of the page and click the “Go” button. You should see a message stating that the SQL file has imported correctly.

import success

Running Houdini

Open the folder where you extracted Houdini in a new explorer window. Hold shift and right click, then click “Open command window here” (or PowerShell).

A command window should come up. Enter the following command and press enter.

python Login.py

You should see output similar to below.

running houdini

If you see anything else, something has gone wrong. You can ask for help on the forums.

Minimise this window, and repeat this step (Open another command window).

This time, run the following commmand.

python World.py

You should see output similar to below.

running houdini world

You should now have two command windows open running both Login.py and World.py.

Testing

Testing Houdini

Congrats! You’re done. Just navigate to http://play.localhost in your browser and sign in with the test account!

Username: Basil

Password: password

testing