From ef0f33351aced9e6e6d6a1605987a1450e731332 Mon Sep 17 00:00:00 2001 From: Martin Michelsen Date: Thu, 2 Mar 2023 22:26:16 -0800 Subject: [PATCH] update readme for windows build --- README.md | 15 +++++++++------ system/config.example.json | 2 ++ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5673b657..4aae9499 100644 --- a/README.md +++ b/README.md @@ -77,15 +77,18 @@ newserv supports several versions of PSO. Specifically: ## Usage -Currently newserv should build on macOS and Ubuntu. It will likely work on other Linux flavors too. It should work on Windows as well, but I haven't tested it recently - the build process could be very manual. Cygwin is likely the easiest Windows environment in which to build newserv. +Currently newserv should build on macOS, Windows, and Ubuntu. It will likely work on other Linux flavors too. There is a fairly recent macOS ARM64 release on the newserv GitHub repository. You may need to install libevent manually even if you use this release (run `brew install libevent`). -If you're using an older AMD64 Mac, you're running Linux, or you just want to build newserv yourself, here's what you do: -1. Make sure you have CMake and libevent installed. (`brew install cmake libevent` on macOS, `sudo apt-get install cmake libevent-dev` on most Linuxes) -2. Build and install phosg (https://github.com/fuzziqersoftware/phosg). -3. Optionally, install resource_dasm (https://github.com/fuzziqersoftware/resource_dasm). This will enable newserv to send memory patches and load DOL files on PSO GC clients. PSO GC clients can play PSO normally on newserv without this. -4. Run `cmake . && make` in the newserv directory. +There is a fairly recent Windows release on the newserv GitHub repository also. It's built with Cygwin, and all the necessary DLL files should be included. That said, I've only tested it on my own machine, so if it doesn't work for you, please open a GitHub issue to let me know. + +If you're using an AMD64 Mac, you're running Linux, or you just want to build newserv yourself, here's what you do: +1. If you're on Windows, install Cygwin. While doing so, install the `cmake`, `gcc-core`, `gcc-g++`, `git`, `libevent2.1_7`, `make`, and `zlib` packages. Do the rest of these steps inside a Cygwin shell (not a Windows cmd shell or PowerShell). +2. Make sure you have CMake and libevent installed. (`brew install cmake libevent` on macOS, `sudo apt-get install cmake libevent-dev` on most Linuxes) +3. Build and install phosg (https://github.com/fuzziqersoftware/phosg). +4. Optionally, install resource_dasm (https://github.com/fuzziqersoftware/resource_dasm). This will enable newserv to send memory patches and load DOL files on PSO GC clients. PSO GC clients can play PSO normally on newserv without this. +5. Run `cmake . && make` in the newserv directory. After building newserv or downloading a release, do this to set it up and use it: 1. In the system/ directory, make a copy of config.example.json named config.json, and edit it appropriately. diff --git a/system/config.example.json b/system/config.example.json index 0c3f2713..8615044d 100644 --- a/system/config.example.json +++ b/system/config.example.json @@ -106,6 +106,8 @@ // via this interface. // If you're doing unusual things, you can also add numbers or "address:port" // strings to this list to listen for tapserver connections on a TCP port. + // This feature requires Unix sockets, so this option does nothing when + // newserv runs under Windows. "IPStackListen": [], // Other servers to support proxying to. If this is empty for any game