Differences

This shows you the differences between two versions of the page.

--- developmentinstallation [2013/09/03 09:35] – created mhgamework
+++ developmentinstallation [2024/08/26 13:57] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Installing the wizards for development ======
+SEE the confluence page for an up-to-date install guide [[https://skymerchant.atlassian.net/wiki/display/DEV/Installation]]
 ===== Requirements =====
@@ Line 31: / Line 34: @@
 The Wizards uses git for development. The main wizards repository is at: https://bitbucket.org/mhgamework/the-wizards. This respository is read-only, so you have to fork it in order to make changes.
-On bitbucket, go to the main wizards repository (link above), and chose fork. Now get your repository url from the main page of your fork. **Use a https URL instead of ssh, unless you like configuring ssh keys**
+  * On bitbucket, go to the main wizards repository (link above), and chose fork.
+  * Now get your repository url from the main page of your fork. **Use a https URL instead of ssh, unless you like configuring ssh keys**. This URL looks like this: // https://mhgamework@bitbucket.org/mhgamework/the-wizards.git //, but with your fork url and your username.
+  * Choose a folder where you want to put The Wizards source and do a git clone. Enter the URL you got earlier. If you want to have automatic login, you can add your password to the URL as follows: //https://username:password@bitbucket.org/mhgamework/the-wizards.git //
+  * Wait for a while until the source gets downloaded.
+  * You can now use show log to see the git tree and checkout a branch. Checkout the 'core' branch, this contains the latest //stable// version of The Wizards.
+New to GIT, or simply still confused? Check out UsingGIT.
+==== Compiling ====
+Now that you have the source and it is checked out, you are read to build and run the project! To build The Wizards the first time, follow these steps:
+(all paths are relative to the source root)
+  * Open /The Wizards.sln
+  * Press Build->Build Solution and wait for it to complete
+  * Check the error list. You might need to Build Solution again, since nuget might have installed new packages.
+  * If there is an error stating that NuGet needs permissions to download packages, you should go to Tools->Options->Package Manager. See that 'Allow NuGet to download missing packages during build' is checked.
+  * If PostSharp was not yet installed and registered, it should  be done so automatically. If it pops up asking to register, you should get a free license from the postsharp website and enter it into the popup window.
+  * If you see no more build errors then you should be ready to go! (warnings are not a problem)
+==== Developing & Running ====
+Now you are ready to go. Open up // /The Wizards.sln // for engine development, or  // /The Wizards Gameplay/The Wizards Gameplay.sln // for gameplay development. The latter compiles a lot faster.
+When working with **The Wizards.sln**:
+  * Set ServerClient as startup project (right-click) in order to run unit tests for the core.
+  * (ADVANCED) Set NewModules as startup project to start the engine, then press F5 when running to chose a test.
+When working with **The Wizards Gameplay.sln**
+  * Start the engine first: // /bin/Binaries/NewModules.exe //. You can pin this to your taskbar.
+  * Your code will now be hotloaded into this engine instance when you build.
+  * Press F5 to open a test, or backspace to open the menu.
+Be sure to read about the SourceDirectoryStructure to find out where you should put your files!