Setup guide
From NetGore Wiki
| Difficulty |  |
|---|---|
| Topics | Engine setup |
| (view all tutorials) | |
This is intended as a guide for getting NetGore set up for the first time and assumes that the system NetGore is being installed on has none of the needed third party components required to use NetGore.
Contents |
Downloads
Required
The following programs are required:
- The latest version of NetGore
- Visual Studio 2010 Express - IDE used to code C# projects. Skip this if you already have Visual Studio 2010. Any version works, and Professional is optimal, but Express is recommended since it is free. Other IDEs can be used (such as Visual Studio 2008), but no support will be given for them. Visual Studio 2010 can be installed side-by-side with older version of Visual Studio.
- MySQL Community Server 5.1 (or later) - Database used by the server and editors. It is recommended to always use the latest version of MySQL.
- .NET 4.0 - Required by all NetGore projects.
Optional
The following programs are not required, but can help improve your experience with using NetGore:
- A MySQL GUI such as SQLyog - SQLyog is just one of the many choices of clients for MySQL. If you prefer another client, please feel free to use it instead. This will allow you to easily alter your database.
- NUnit - Required to run the unit tests in NetGore, but not required to run NetGore. Still, it is highly recommended.
Installing
Install Visual Studio and MySQL Community Server (if not already installed). The default settings will work fine.
Extract the NetGore project download to any directory. The rest of this guide will assume that you extracted the NetGore project to C:\NetGore\.
Running the InstallationValidator
The InstallationValidator can be found in the root NetGore directory. This program helps ensure that everything needed is installed, and will import the database dump automatically for you so you can run the demo game that comes with NetGore.
Run the InstallationValidator by double-clicking InstallationValidator.bat. If you extracted to C:\NetGore\, this will be located at C:\NetGore\InstallationValidator.bat. When the program opens, click Run to run the tests. If all goes well, all the tests will pass. If any of the tests fail, it will provide you with details on what is wrong and how to resolve it.
Running NetGore
Double-click the netgore.sln file located in \NetGore to open it with Visual Studio. Once open, build and run the solution by pressing F5 in Visual Studio, or by clicking the "Start" button in the toolbar. This will build the project and, if the build is successful, run it.
By default, only the client (DemoGame.Client) project will be run, which isn't very useful since you won't have a server to log in to. To change the startup project or run multiple projects at once, right click on Solution NetGore > Properties in the solution explorer on the left hand side of the screen. This should open a new window containing the start-up projects. Select "Multiple startup projects" and make sure all projects are set to None in the "Action" column, then set DemoGame.Client and DemoGame.Server to Start.
What next?
Now that you have NetGore all set up and running, it is time to start playing around with it and learning how things work. Check out the NetGore tutorials category for a listing of all tutorials.
Help with setup problems
If you encounter any problems while trying to set up NetGore, please first check the common setup issues page.
If you still have problems, feel free to ask for help on the NetGore forums.
