Setup Guide for Development
Make sure you have all of the following installed before proceeding, you will need them to run the source code. Note: While Visual Studio is not explicitly needed to compile some things, it is the only supported IDE by the team.
- Visual Studio 2013 or Visual Studio 2015
- Visual Studio Web Essentials 2013 or Visual Studio Web Essentials 2015
- TypeScript
Checkout the latest version of the code you want to use. If you are interested in running this for creating a game, checkout master or the latest release. If you are interested in developing code, checkout development. Master is considered the 'stable branch'. Nothing should be broken there, theoretically.
Running the server now requires a MySQL or MariaDB server instance running. To configure the connection open the App.config file in the OpenORPG.Server project, and change the connectionString attribute in the connectionStrings section accordingly with the appropriate information.
- server: the server address, '127.0.0.1' if the database is running on the same machine
- port: by default 3306
- database: default is 'orpg', likely no need to change this
- user: the database username, by default 'root'
- password: by default this is blank
If you want to just run the client and server to check out the sample game, do the following:
- Right click Solution "OpenORPG" in the Solution Explorer.
- Left click Properties at the bottom of the list.
- Fill out the startup projects to match that of the image below
- Then right click the solution again, and click "Build Solution".
Setup the configuration for the OpenORPG.TypeScriptClient project.
- Right click on the OpenORPG.TypeScriptClient project.
- Left click Properties at the bottom of the list.
- Make sure that the Web tab is selected, and the content in it matches the image below.