Win5X on Windows #

Installation on Windows is not automatic. It might be better to use Ubuntu server and edit source there if you are inexperienced.

Required applications #

Download (in order):

1. Git
2. Memurai (Developer Edition)
3. NPM
4. XAMPP
5. Composer
6. MongoDB Server
7. MongoDB Compass
8. Java - if you will use Win5X installer to download sources

Download Win5X source #

Download Win5X installer.

Open terminal and execute:

java -jar win5x-installer.java

Open http://localhost:8000 in your browser.

Choose "Source code only" option and enter your license key. Once download finishes, close the terminal (CTRL + C).

Alternatively, you can just download source code from your Ubuntu server directly.

Extract downloaded archive contents to <XAMPP path>/htdocs.

Environment file #

Go to htdocs XAMPP directory and copy .env.example, then rename it to .env.

Run php artisan key:generate in your terminal.

Open .env file:

... set APP_DEBUG to true

... set VITE_RECAPTCHA_KEY to your recaptcha key. If you don't have one - get it here (reCAPTCHA 2).

Download dependencies #

Download MongoDB for PHP extension. By default, XAMPP installs thread-safe version of PHP.

Place php_mongodb.dll in < xampp >/php/ext directory.

Edit < xampp >/php/php.init, find chunk of lines starting with extension= and add following line before it:

extension=mongodb

Uncomment (remove ; at the start) for curl, gmp, mbstring and gd extensions.

Install PHP dependencies #

Run composer install in htdocs directory. Composer will notify you if some PHP extensions are not installed.

Edit apache config #

Open < xampp >/apache/conf/httpd.conf, find DocumentRoot and replace it with:

DocumentRoot "C:/xampp/htdocs/public"
<Directory "C:/xampp/htdocs/public">
    #
    # Possible values for the Options directive are "None", "All",
    # or any combination of:
    #   Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews
    #
    # Note that "MultiViews" must be named *explicitly* --- "Options All"
    # doesn't give it to you.
    #
    # The Options directive is both complicated and important.  Please see
    # http://httpd.apache.org/docs/2.4/mod/core.html#options
    # for more information.
    #
    Options Indexes FollowSymLinks Includes ExecCGI

    #
    # AllowOverride controls what directives may be placed in .htaccess files.
    # It can be "All", "None", or any combination of the keywords:
    #   AllowOverride FileInfo AuthConfig Limit
    #
    AllowOverride All

    #
    # Controls who can get stuff from this server.
    #
    Require all granted
</Directory>

Change C:/xampp if your XAMPP install directory is different.

Start apache server #

Open XAMPP and start apache.

Build frontend #

Run npm run build in both @admin and @web directories.

Register on the website #

Open http://localhost in your browser.

Ignore the "Maintenance" message you will encounter once you open the website for the first time. This is a guest-only message that appears if the license key is missing.

You will not be able to do anything until you log in. Register on the website.

Open MongoDB compass #

Give yourself all permissions - press "Connect" in Compass (no config required), select users collection.

Change roles parameter from [] to [{"id":"*"}] and save the changes.

Refresh the browser page #

Website will prompt you to go to the dashboard. Follow the steps to activate your license.

Wrapping up #

Win5X is successfully installed on your home machine.

API games will not work unless you open port 80 on your PC and change callback urls to your IP instead of the server domain.