Skip to content

EN_Building

Jump to bottom
EggEgg edited this page Nov 23, 2023 · 3 revisions

Content Overview

If this is your first time here, we recommend that you read the entire content of this document.

Prerequisite Environment Requirements

First, you need to make sure you have installed the following software:

  • .NET 6.0 Runtime. It is used to build and run the software.
  • Git. It is used to clone the source code and fetch updates for this software.
  • Protocol Buffers Compiler (protoc), and add it to your system's PATH environment variable. It is used to compile necessary files in real time. For consistency, we recommend using version 21.12.
    Please note to download the compressed package starting with protoc according to your system from the release page. Here are some download links: v21.12 Windows x64 | v21.12 Linux x64
    Since Version v1.1.0, you don't need to install protoc any more. If you still want to use protoc Executable on your own computer, please read the following tutorial about OuterInvokeConfig.cs.
  • A real server.

In addition, I personally strongly recommend that you:

  • Ensure stable access to GitHub when running the build (./update).
  • Use VS Code for path shortcut jumps, JSON Schema support, etc.

If for some reason you are unable to add the above software to the system environment variables, you can open HandlerGenerator/OuterInvokeConfig.cs. You will see the following code:

public const string? protoc_path = null;
/// ...
public const string dotnet_path = "dotnet";
/// ...
public const string git_path = "git";

Replace the values of the above constants with the installation locations of your programs. Note that this will not change the program locations referenced in the script. You may also need to modify them accordingly.

Performing the Build

Generally speaking, the most common build is to directly run the update script ./update. This will automatically update your Proto version and rerun the build (if there are updates).

./update will run the HandlerGenerator project. It may prompt the user for action during runtime (or simply prompt you to press Enter to exit). If you want the program to run continuously, you can use ./update -y.

If you are a developer and have changed Proto yourself, you may want to regenerate Protoshift Handlers without pulling updates. In this case, it is recommended that you run dotnet run directly in the HandlerGenerator folder to meet your needs.

Also, command line parameters are actually parsed by HandlerGenerator. Therefore, any parameters mentioned above that can be used with ./update can also be used with dotnet run - but note the syntax of dotnet run: parameters passed to dotnet run need to be separated from program parameters with --.

Proto Remote Fetch Management

You can use the following parameters to fetch Proto from remote:

./update --branch-oldprotos [branch] --branch-newprotos [branch]

The Branch should be available in the remote repository.

You can view the default Proto repository here. You can also change it in HandlerGenerator/Gencode_Configuration/protobuf_source_git.txt.

Note that using a repository other than GitHub may change some behaviors of the program. Since it has not been fully tested, it may bring unknown problems.

If no parameters are specified and there is no local Proto, the program will clone using the default branch. It is configured in HandlerGenerator/Gencode_Configuration/default_protobuf_branches.txt.

Performing Personalized Configuration

After generating Protoshift Handlers, you should modify config.json for effective configuration. If you edit config.json with an editor that supports JSON Schema, you should be able to see field comments and use the auto-fill feature.
After configuring config.json, you should check whether resources is correctly configured. For how to correctly configure resources, please refer to Wiki - Resources.

Also, when you enter the game, you should see the following effect. If you want to disable this feature, you can turn it off by setting #/WindyConfig/OnlineExecWindyMode to Disabled in config.json.

Windy Preview

Exporting a Single Release Version

Sometimes, you may want to export a single release version for long-term use, or move it to other devices, independent of the code.

If you want to export a release version, you can run the following command:

./scripts/publish

This will generate to the Builds folder in Release configuration after successfully restoring Proto and generating Handlers, with the folder name being output_[today's date]_[latest Git Hash of the local repository], such as output_20231007_505e671421.

If your real server runs on a Unix platform, it is strongly recommended that you run the Protoshift server and the real server on the same machine (for containerized servers, other similar methods may be used), because at this time, local network communication between the Protoshift server and the real server will directly use memory copy. The relevant data from network testing indicates that this can increase network speed by more than $45%$.

Post-Build Tasks

If you want to run automated tasks (such as scp), you can customize the post-build task script:

  1. Find the HandlerGenerator/Gencode_Configuration folder. There are two files in the directory, afterbuild_task_win.tmpl.ps1 and afterbuild_task_unix.tmpl.sh.
  2. Depending on your current platform, choose one to create a copy in the directory and remove .tmpl from the file name. For example, if your current system is Windows, you should clone afterbuild_task_win.tmpl.ps1 and rename it to afterbuild_task_win.ps1.
  3. When HandlerGenerator completes the build, the full path of the generated Build folder will be passed into the script as the only parameter. You can then complete any tasks you want to complete by writing the script.
Clone this wiki locally