Darwinbots 3 - Revision history

Numsgil: /* Where's the DB3 EXE? */

2017-05-06T10:06:40Z

‎Where's the DB3 EXE?

Numsgil: /* You have the code, now what? */

2017-05-06T10:05:42Z

‎You have the code, now what?

Numsgil: /* Junk directories and bin folders */

2017-05-06T09:59:15Z

‎Junk directories and bin folders

Numsgil: /* How you should set up your SVN projects and local directories */

2017-05-06T09:57:53Z

‎How you should set up your SVN projects and local directories

Numsgil: /* Getting the compiler */

2017-05-06T09:56:38Z

‎Getting the compiler

Numsgil: 2014 update

2014-06-28T23:22:25Z

2014 update

Numsgil: /* Downloading the dependencies */

2011-12-28T18:50:46Z

‎Downloading the dependencies

Numsgil at 00:32, 28 December 2011

2011-12-28T00:32:12Z

Numsgil at 02:08, 22 December 2011

2011-12-22T02:08:37Z

Numsgil at 00:25, 20 October 2011

2011-10-20T00:25:32Z

@@ Line 38: / Line 38: @@
 === Where's the DB3 EXE? ===
-There isn't one yet.  The idea is that it's getting built from the ground up, one module at a time.  So there's no central project yet that actually uses all the modules at once.  Instead each module is tested and developed individually based on some simple use cases.  At the end, there'll be a nice product suite that should combine fairly organically into a final EXE.  With any luck, anyway :P
+Under Modules\Darwinbots3 there is a Darwinbots3 solution.  At the moment the Darwinbots3 binary is pretty empty, but there is a Bot.Testbed application that is starting to come together.
 == Coding standards ==

@@ Line 35: / Line 35: @@
 === You have the code, now what? ===
-Each module has its own solution file.  Because many modules have inter-dependencies, the release libraries are on the repository so you shouldn't need to compile all the projects first time.  You can just open one up randomly and compile it and it'll work.  Alternatively, in the Scripts folder, there is a batch file called BuildAll-Release.  Run that file.  You might need to run it more than once depending on what order the batch file decides to build the modules in.
+You'll need to build all the different modules.  There isn't a single solution file to build everything (on purpose, since lots of smaller solution files are more manageable), but in the Scripts folder there's a batch file called build.py that will build everything in the correct order.  Run that file.  If you have a different version of Visual Studio than 2013 you'll need to run it from the command line with the --version flag set.  eg: For Visual Studio 2017 the version is 15 (confusingly), so you'd set --version=15 and it should work.
 === Where's the DB3 EXE? ===

@@ Line 32: / Line 32: @@
 === Junk directories and bin folders ===
-The projects are set up to place bulky build files in the Junk directory.  This directory should always be empty on the repository, except for the "About This Folder.txt" file.  Final EXEs are built to the Bin folder.  Only release binaries are on the repository, and are what projects use when they want to import another (for instance, the release build of UnitTestSharp is used for the unit testing projects).  Note that this can cause weird problems if you build a project in debug mode and not in release mode, and then submit code changes to the repository, since the binary and source code will be out of sync with each other.
+The projects are set up to place bulky build files in the Junk directory.  This directory should always be empty on the repository, except for the "About This Folder.txt" file.  Final EXEs are built to the Bin folder.  None of the binaries are checked in to the repository.  The binaries in the Bin folder are what projects use when they want to import another (for instance, the release build of UnitTestSharp is used for the unit testing projects).
 === You have the code, now what? ===

@@ Line 21: / Line 21: @@
 === How you should set up your SVN projects and local directories ===
-You can dump the source whereever you want.  Everything is set up with relative paths.  I would suggest something like this just for sanity, though:
+You can dump the source whereever you want.  Everything is set up with relative paths.  I usually put it on the root level myself:
 C:\
-* \Darwinbots3
+* \Darwinbots3Source <-- sync this to the trunk directory in the repository, or one of the tags or branches if you're working from them
 === Visual Studio solution files ===

@@ Line 3: / Line 3: @@
 == Compiling the code ==
 === Getting the compiler ===
-You'll need a version of Visual C# 2013 (this all might run under Mono in Linux, but I don't have either so no promises).  You can download [http://msdn2.microsoft.com/en-us/express/aa975050.aspx C# express] for free.  The whole process will probably take several hours to do.
+You'll need a version of Visual C# that's at least 2013.  Newer versions should work fine, but I haven't tested it.  (Also, this all might run under Mono in Linux, but I don't have either so no promises).  You can download [http://msdn2.microsoft.com/en-us/express/aa975050.aspx C# express] for free.  The whole process will probably take several hours to do.
 === Downloading the dependencies ===

@@ Line 1: / Line 1: @@
 Darwinbots 3 is a long term project to recode Darwinbots in C# as a brand new program.  Every feature and aspect is going to be examined and refined as its added, in a framework that will ensure robustness and agility in handling bugs and new features.  The code can be browsed: [http://svn.darwinbots.com/Darwinbots3/ http://svn.darwinbots.com/Darwinbots3/]
 == Compiling the code ==
 === Getting the compiler ===
-You'll need a version of Visual C# 2010 (this all might run under Mono in Linux, but I don't have either so no promises).  You can download [http://msdn2.microsoft.com/en-us/express/aa975050.aspx C# express] for free.  The whole process will probably take several hours to do.  The good news is that even if you never start programming Darwinbots, you just found a free high quality compiler :D
+You'll need a version of Visual C# 2013 (this all might run under Mono in Linux, but I don't have either so no promises).  You can download [http://msdn2.microsoft.com/en-us/express/aa975050.aspx C# express] for free.  The whole process will probably take several hours to do.
 === Downloading the dependencies ===
-To compile the project, you need:
+To compile/run the project, you need:
-* [http://research.microsoft.com/~mbarnett/ILMerge.aspx ILMerge] - Allows multiple .NET assemblies (.DLLs) to be packaged into a single assembly.
+* DirectX installed.  Needs to be the latest version installed.  Try running the [http://www.microsoft.com/en-us/download/confirmation.aspx?id=35 web installer] to see if you have the latest version.
 === Get either Subversion or a Subversion client ===
 For those unfamiliar with version control, it's basically a way to ensure that multiple people can work on the same source code.  You "check out" a copy of the current source code from the repository and store it locally on your computer.  You then change the source code in places and "commit" it back to the repository.  If there have been changes in the mean time that conflict with your changes (should be a pretty rare occurrence), SVN will notify you and ask you to resolve the problem before the commit is applied to the central code repository.  Another advantage of working this way is that the entire evolution of the code is tracked.  If some bug is found that was introduced months ago, you can browse through the repository at different versions of the program to find what changes caused it.
-You can either try one of the [http://www.sliksvn.com/en/download Subversion commandline builds] if you're into that sort of thing, or try one of the GUI based Subversion clients.  Numsgil uses [http://www.syntevo.com/smartsvn/index.html SmartSVN], which he highly recommends.
+You can either try one of the [http://www.sliksvn.com/en/download Subversion commandline builds] if you're into that sort of thing, or try one of the GUI based Subversion clients.  I like [http://www.syntevo.com/smartsvn/index.html SmartSVN] myself.
 === Accessing the repository and committing ===
@@ Line 33: / Line 25: @@
 ** \Source <-- sync this to the trunk directory in the repository, or one of the tags or branches if you're working from them
-Again, the source folder doesn't have to be inside your Darwinbots3 folder, but life will probably be easier if it is.
+Again, the source folder doesn't have to be inside a Darwinbots3 folder, but life will probably be easier if it is.
 === Visual Studio solution files ===
-Instead of one large master solution file to build the entire project, each module maintains its own solution file for just that solution.  Usually it will contain the module itself, some unit tests, and a test app.  This is to make checking unit tests for errors simpler, among other purposes.  All the modules spit out binaries in to the bin/Release directory, and these are checked in, so there's no need to rebuild everything very often (assuming source and binary and kept in sync, which will usually be true).  To build the entire project, you'll need to run one of the build scripts in the Scripts directory.  Note that you shouldn't need to do this very often.
+Instead of one large master solution file to build the entire project, each module maintains its own solution file for just that solution.  Usually it will contain the module itself, some unit tests, and a test app.  This is to make checking unit tests for errors simpler, among other purposes.  All the modules spit out binaries in to the bin/Release directory, and these are checked in, so there's no need to rebuild everything very often (assuming source and binary and kept in sync, which will usually be true).  To build the entire project, you'll need to run one of the build scripts in the Scripts directory.
 === Junk directories and bin folders ===
-The projects are set up to place bulky build files in the Junk directory.  This directory should always be empty on the repository, except for the "About This Folder.txt" file.  Final EXEs are built to the Bin folder.  Only release binaries are on the repository, and are what projects use when they want to import another (for instance, the release build of UnitTestSharp is used for the unit testing projects).  Note that this can cause weird problems if you build a project in debug mode and not in release mode, and then submit code changes to the repository, since the binary and source code will be out of date.
+The projects are set up to place bulky build files in the Junk directory.  This directory should always be empty on the repository, except for the "About This Folder.txt" file.  Final EXEs are built to the Bin folder.  Only release binaries are on the repository, and are what projects use when they want to import another (for instance, the release build of UnitTestSharp is used for the unit testing projects).  Note that this can cause weird problems if you build a project in debug mode and not in release mode, and then submit code changes to the repository, since the binary and source code will be out of sync with each other.
 Under the scripts directory, there are scripts for publishing from the Bin directory to the top level Darwinbots3 directory (essentially publishing locally) and scripts to clean the junk folders (delete files and such).
@@ Line 46: / Line 40: @@
 === You have the code, now what? ===
-Each module has its own solution file.  Because many modules have interdependencies, the release libraries are on the repository so you shouldn't need to compile all the projects first time.  You can just open one up randomly and compile it and it'll work.  Alteratively, in the Scripts folder, there is a batch file called BuildAll-Release.  Run that file.  You might need to run it more than once depending on what order the batch file decides to build the modules in.
+Each module has its own solution file.  Because many modules have inter-dependencies, the release libraries are on the repository so you shouldn't need to compile all the projects first time.  You can just open one up randomly and compile it and it'll work.  Alternatively, in the Scripts folder, there is a batch file called BuildAll-Release.  Run that file.  You might need to run it more than once depending on what order the batch file decides to build the modules in.
 === Where's the DB3 EXE? ===
@@ Line 79: / Line 73: @@
 Note that these files alphabetically sort according to when they are expected to release.  This is important.

@@ Line 10: / Line 10: @@
 To compile the project, you need:
-* [http://www.microsoft.com/download/en/details.aspx?id=15300 XNA 3.0] - A game library released by Microsoft which is used for graphics.
+* [http://www.microsoft.com/download/en/details.aspx?id=39 XNA 3.1] - A game library released by Microsoft which is used for graphics.
 To distribute the project (which you probably don't care about), you need:

@@ Line 12: / Line 12: @@
 * [http://www.microsoft.com/downloads/thankyou.aspx?familyId=7d70d6ed-1edd-4852-9883-9a33c0ad8fee&displayLang=en XNA 3.0] - A game library released by Microsoft which is used for graphics and math related things.
-To help work on parts of the project, you need:
+To distribute the project (which you probably don't care about), you need:
 * [http://research.microsoft.com/~mbarnett/ILMerge.aspx ILMerge] - Allows multiple .NET assemblies (.DLLs) to be packaged into a single assembly.
 * [http://madebits.com/netz/index.php NETz] - Allows packing of the exe to make it smaller.
-* Double check what needs to be installed .NET wise and XNA wise (redistributables).
+* (TODO: Double check what needs to be installed .NET wise and XNA wise (redistributables)).
 === Get either Subversion or a Subversion client ===