Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 3.32 KB

ErupeServer.README.md

File metadata and controls

92 lines (65 loc) · 3.32 KB
Raw

Erupe

WARNING

This project is in its infancy and has no reliable active developer, no documentation, and no support.

This project has been solely developed in my spare time for the educational experience of making a server emulator, which I haven't done before. Expectations regarding functionally and code quality should be set accordingly.

General info

Currently allows a JP MHF client (with GameGuard removed) to:

  • Login and register an account (registration is automatic if account doesn't exist)
  • Create a character
  • Get ingame to the main city
  • See other players walk around
  • Do quests (Only quests shipped with the game are on the counter. Requires binary quest files not in the repo)
  • Use (local) chat*
  • Partial guild support

All features can be assumed to be very limited or buggy.

Installation

Server

  1. Clone the repo with git clone https://github.com/Andoryuuta/Erupe.git

  2. Install PostgreSQL

  3. Launch psql shell, CREATE DATABASE erupe;.

  4. Setup database with golang-migrate:

    Windows:

    > go get -tags 'postgres' -u github.com/golang-migrate/migrate/v4/cmd/migrate/

> set POSTGRESQL_URL=postgres://postgres:password@localhost:5432/erupe?sslmode=disable

> cd erupe

> migrate -database %POSTGRESQL_URL% -path migrations up

    Linux:

    > go get -tags 'postgres' -u github.com/golang-migrate/migrate/v4/cmd/migrate/

> export POSTGRESQL_URL=postgres://postgres:password@localhost:5432/erupe?sslmode=disable

> cd erupe

> migrate -database $POSTGRESQL_URL -path migrations up

    (Replacing postgres:password with your postgres username and password)

  5. Edit the config.json

    Namely:

    • Update the database username and password
    • Update the host_ip and ip fields (there are multiple) to your external IP if you are hosting for multiple clients.

  6. Place quest/scenario binaries.

    The quest and scenario binary files should be placed in bin/quests/ and bin/scenarios respectively.

Launcher

Erupe ships with a rudimentary custom launcher, so you don't need to obtain the original TW/JP files to simply get ingame. However, it does still support using the original files if you choose to. To set this up, place a copy of the original launcher html/js/css in ./www/tw/, and /www/jp/ for the TW and JP files respectively.

Then, modify the the /launcher/js/launcher.js file as such:

  • Find the call to startUpdateProcess(); in a case statement and replace it with finishUpdateProcess();. (This disables the file check and updating)
  • (JP ONLY): replace all uses of "https://" with "http://" in the file.

Finally, edit the config.json and set UseOriginalLauncherFiles to true under the launcher settings.

Usage

Server

cd Erupe
go run .

Note: If you experience port-binding issues and have Hyper-V/wsl2 installed, please see this issue.

Client

Add to hosts:

127.0.0.1 mhfg.capcom.com.tw
127.0.0.1 mhf-n.capcom.com.tw
127.0.0.1 cog-members.mhf-z.jp
127.0.0.1 www.capcom-onlinegames.jp
127.0.0.1 srv-mhf.capcom-networks.jp

Run mhf.exe normally (with locale emulator or appropriate timezone).

Note: If you are switching to/from the custom launcher html, you will have to clear your IE cache @ C:\Users\<user>\AppData\Local\Microsoft\Windows\INetCache.