Moonlight

Disclaimer

I do not guarantee that this will make any substantial progress. Use at your own peril.

Table of Contents

• Environment Variables
• Source Code Rundown
  • Server Source Code
  • Auth Hook Source Code
  • Launcher Source Code
• Installation
  • Requirements
  • v214 Client Files
  • Server WZ Files
  • Start The Server
• Contributing
• Privacy Policy
• License

Environment Variables

Some aspects of the code-base relies on a filled out .env file. Be sure to look at the .env.local file for what a valid example looks like.

Source Code Rundown

Server Source Code

You can find the source code for the server in the server directory.

The applicable dat and wz files are not included.

Auth Hook Source Code

You can find the source code for the server auth hook in the auth_hook directory.

Launcher Source Code

You can find the source code and applicable README for the custom launcher in the launcher directory.

Installation

Requirements

The server and its database are hosted in Docker containers, so you will need Docker installed on your machine.

For Windows users, do be sure to pick up Docker Desktop and not just the Docker daemon.

v214 Client Files

We highly recommend getting all of GMS v214 through Steam via the use of Depot Downloader.

1. Open the Steam console
2. Run download_depot 216150 216151 976750626611673486
3. Wait until the download has finished

If this method does not work for you due to being outside of North America, there should be publicly available Mega.nz download links out there.

Server WZ Files

Due to the immense file size of dumped WZ files, we do not include them in this repository.

These files are required though, and you should dump them yourself.

1. Download the latest release of HaRepacker Resurrected
2. Using the v214 client files you dumped earlier, open HaRepacker and load all of the client’s WZ files
3. Using HaRepacker, dump all of the WZ files by clicking on Tools -> Export File(s) To -> Private Server XML
4. Wait until the dump has finished and move the dumped WZ files to Server/wz

Start The Server

Once all previous steps have been completed, you may run the server by typing ./start.sh in your terminal while in this directory.

The first time you start the server, you may have to wait for several minutes as the Docker images and volumes are set-up, as well as for when the server generates all necessary DAT file data.

Contributing

See our Contributing standards for information on contributing to development.

Privacy Policy

In Moonlight, information is kept between you and our server and all sensitive information is encrypted.

For more information, see our Privacy Policy.

License

This project is licensed under GNU GPL 3.

For more information about the license, check out the LICENSE.