Detailed Build Instructions

From Meridian 59 - Open Source Wiki
Jump to: navigation, search

Prerequisites

Source Repositories

  • Choose a repository to work from. All known repositories are listed on the Server List. This project uses OpenMeridian/Meridian59 as its base.
  • Download the source code, either with a git client or with the "Download ZIP" option from your chosen repository.

Compile with Visual Studio GUI

  • Open the Meridian59.sln VS solution file and select "Build solution" from the Build menu, or press CTRL+SHIFT+B to build.
  • If you are working on one particular project (e.g. the KOD code) and have already built the whole solution, you can rebuild just that one project to save time.
  • Please note that this method of compiling is much faster than Command line, so while you can do both we recommend skipping the next section and going straight to "Getting Started: Server"

Compile with Visual Studio Command Prompt

  • Locate your Visual Studio install folder, usually something like "C:\Program Files (x86)\Microsoft Visual Studio 12.0"
  • Navigate to the Common folder, and then the Tools folder. Example: "C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\Tools"
  • Create a shortcut (by right-clicking on vsvars32.bat and selecting Create shortcut) called "Meridian Development Shell" on your desktop or in your start menu with the following property:
     Target: %windir%\system32\cmd.exe /k "C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\Tools\vsvars32.bat"
  • OPTIONAL: set the "Start In" property of your shortcut to the folder that contains the meridian source code for ease of use.
  • Open the Meridian Development Shell and navigate to the folder containing the source code.
  • type
    nmake DEBUG=1
    and press enter to compile the project.

Getting Started: Server

After compilation completes, browse to the .\run\server folder, and double click "blakserv.exe" to start the server.

  • Go to the "Administration" tab on the server's interface and enter the command:
 create account admin username password
  • You'll get back a message like "Created ACCOUNT 4"
  • Then create a character slot on that account with
 create admin 4
  • You'll now be able to log in with this account name and password. Be sure to "save game" from the server interface to save this new account.

Note that any time you recompile KOD code, if blakserv.exe is running you should load the changes into the server by clicking the 'reload system' arrow icon, next to the 'save game' disk icon.

Getting Started: Client

After compilation completes, the client is located at .\run\localclient

You can point your local client at your local server by running the client (meridian.exe) with command line flags, like this:

 meridian.exe /U:username /W:password /H:localhost /P:5959

The build process will attempt to make a shortcut to meridian.exe with the correct command line flags, which you can find in .\run\localclient. If this shortcut is not present, you can create it by right-clicking meridian.exe and selecting Properties, and adding /H:localhost /P:5959 after the existing link in the Target: box.

The source repository does not contain the complete graphics and audio. The build process will attempt to copy these from any client you have installed via the patcher. If this doesn't work, you can attempt to run postbuild.bat manually, or copy the files manually from another Meridian 59 installation (however this should not be necessary).

For further information please join the #Meridian59 channel on irc.esper.net.