Zero-K:Developing - Revision history

Aquanim: /* Debugging infrastructure */

2025-12-31T01:46:20Z

Debugging infrastructure

Aquanim: /* Modifying infrastructure/tools */

2025-12-31T01:43:11Z

Modifying infrastructure/tools

Strategineer: typo

2025-12-02T22:26:11Z

typo

Mach56: Add navbox

2025-11-24T11:53:01Z

Add navbox

Histidine: /* Wiki */ Update unit page instructions

2024-05-12T04:55:35Z

Wiki: Update unit page instructions

RandomX: Fixed broken link to Notepad++ download and brought in an image from imgur in case it goes away at some point.

2023-07-23T01:42:40Z

Fixed broken link to Notepad++ download and brought in an image from imgur in case it goes away at some point.

Aquanim: /* Modifying infrastructure/tools */

2023-06-27T11:20:01Z

Modifying infrastructure/tools

Aquanim: /* Modifying infrastructure/tools */

2023-06-27T11:19:45Z

Modifying infrastructure/tools

Licho: /* Releasing Zero-K on steam safely */

2022-05-11T13:45:05Z

Releasing Zero-K on steam safely

RandomX: Removed a strange double-bullet, put gallery where it is mentioned, used arrows where arrows are implied.

2021-10-27T05:47:51Z

Removed a strange double-bullet, put gallery where it is mentioned, used arrows where arrows are implied.

@@ Line 158: / Line 158: @@
 **(As of June 2023) a few extra steps: in Visual Studio open Tools - Options - Projects and Solutions - Web Projects and tick "Use the 64 bit version of IIS Express...". In <code>ZkLobbyServer/ZkLobbyServer.cs</code> you may need to comment out the line <code>Task.Factory.StartNew(()=>ReplayStorage.Instance.MigrateReplays(), TaskCreationOptions.LongRunning);</code> currently on line 104.
-TODO: add download links for sample database tables here. Users and clans are probably easier to make yourself for most purposes. For now, if you need this ask Licho, Histidine, DeinFreund or Anarchid. Aquanim has sample tables for maps and Planetwars structures, if that is all that you need.
+Aquanim has sample tables for maps, Planetwars structures, users and replays available on request.
 === Testing ===

@@ Line 155: / Line 155: @@
 ** Right click asp.net → properties → web → check "Specific Page" and leave it blank. Otherwise you get errors when trying to host locally.
 ** Make sure SQL Server is running (check the Sql Server Configuration Manager in the Start Menu). If you can't connect, edit the data source for <code>ModeType.Local</code> in <code>GlobalConst.cs</code> (currently line 46) to say something like:<br/><code>Data Source=<hostname (usually your computer name)>\SQLSERVER</code>
-** To make things run smoothly the following changes might also be a good idea: In <code>Shared/PlasmaShared/GlobalConst.cs</code> (currently line 137) replace the DefaultEngineOverride with whatever engine version is current. Comment out lines 190 and 238-298 of <code>Zero-K.info/AppCode/PlasmaServer.cs</code> unless somebody can supply instructions on how to make the torrent errors go away.
+** To make things run smoothly the following changes might also be a good idea: In <code>Shared/PlasmaShared/GlobalConst.cs</code> (currently line 137) replace the DefaultEngineOverride with whatever engine version is current. Stick a "return false" at the beginning of UploadAndDeleteFileAsync in <code>ZkLobbyServer\ReplayStorage.cs</code> so that your local server does not attempt to upload replays etc. to Azure.
 **(As of June 2023) a few extra steps: in Visual Studio open Tools - Options - Projects and Solutions - Web Projects and tick "Use the 64 bit version of IIS Express...". In <code>ZkLobbyServer/ZkLobbyServer.cs</code> you may need to comment out the line <code>Task.Factory.StartNew(()=>ReplayStorage.Instance.MigrateReplays(), TaskCreationOptions.LongRunning);</code> currently on line 104.

@@ Line 43: / Line 43: @@
 These guidelines are not necessarily followed in old files so updating them with a separate commit is a good idea prior to making large changes. Also, unitdefs use two-space indentation instead of tabs.
-There are a few guildines for dealing with Spring functions.
+There are a few guidelines for dealing with Spring functions.
 * Localisation of Spring.Function should be named spFunction.
 * Localisation of Spring.MoveCtrl.Function should be named spMoveCtrlFunction.

← Older revision		Revision as of 11:53, 24 November 2025
Line 227:		Line 227:
	* Go to zero-k.info engine list, click rebuild steam on current engine version		* Go to zero-k.info engine list, click rebuild steam on current engine version

		+	{{Navbox manual}}
	[[Category:Development]]		[[Category:Development]]

@@ Line 207: / Line 207: @@
 === Unit pages ===
-Part of each unit page is autogenerated by the [//github.com/ZeroK-RTS/SpringRTS-Tools/tree/master/unitguide Unit Guide tool], and uploaded by the [//github.com/ZeroK-RTS/Zero-K-Infrastructure/blob/master/Fixer/WikiPortingMW.cs Wiki bot].
+Unit infoboxes can now be automatically kept up to date using [[Template:Autoinfobox zkunit]]. See the template page and [[Module:UnitData]] for more information.
-Run <code>export_unit_templates.sh</code> to generate wiki templates for each unit (see <code>export_unit_templates.lua</code> for some configuration options), then have the bot read the generated text files and edit the unit pages accordingly (requires Visual Studio setup as detailed above). The text output can also be used to manually edit pages.
+Unit buildicons and radar icons require manual uploading to the Zero-K website. (<code>zero-k.info/zkmanual/www/unitpics</code> and <code>/icons</code> respectively). If an icon is missing, poke Licho or Histidine to fix it. Alternatively, buildicons can be obtained directly from the GitHub CDN.
 == itch.io builds ==

@@ Line 7: / Line 7: @@
 ** Have responsibility for your changes/commit. Do not leave bugs that require other people to fix.
 * "Readability & performance are equally important."
-** Optimize code but not to the point of unreadability. [http://c2.com/cgi/wiki?RulesOfOptimization Remember the rules of optimization]:
+** Optimize code, but not to the point of unreadability. [//c2.com/cgi/wiki?RulesOfOptimization Remember the rules of optimization]:
 *** Don't.
 *** Don't (yet).
@@ Line 73: / Line 73: @@
 == Modifying the game ==
 :''For personal modding, see [[Mod Creation]]''
-Follow the instructions in 'Getting sources' the download the Zero-K game sources. Feel free to inspect and edit the game files. Most developers using Windows edit lua files with [https://notepad-plus-plus.org/download/v7.6.6.html Notepad++].
+Follow the instructions in 'Getting sources' the download the Zero-K game sources. Feel free to inspect and edit the game files. Most developers using Windows edit lua files with [//notepad-plus-plus.org/download/ Notepad++].
 To test your changes:
@@ Line 148: / Line 148: @@
 === Debugging infrastructure ===
 * To run a project right click it, choose "set as startup project" and hit F5 to run using debugger.
-* You can enable multiple startup projects to test entire infrastructure locally (game servers, lobby etc). Enable asp.net, springie and ZeroKLobby projects to test it all together. [http://i.imgur.com/2mgizUJ.png Setup]
+*[[File:Startup projects.png|thumb|Startup projects setup.]] You can enable multiple startup projects to test entire infrastructure locally (game servers, lobby etc). Enable asp.net, springie and ZeroKLobby projects to test it all together.
 * To run asp.net:
 ** It's required that you install MS SQL Server on your local PC.

@@ Line 223: / Line 223: @@
 See [https://springrts.com/wiki/Development:Getting_Started Spring Engine Development]
-== Releasing Zero-K on steam safely ==
+== Releasing Zero-K on steam ==
-* Force push to stable branch
+* Force push master to stable branch
-* In TeamCity click on Deploy LIVE Zero-K Lobby - this will build Zero-K.exe chobby wrapper
+* Go to zero-k.info engine list, click rebuild steam on current engine version
 [[Category:Development]]

@@ Line 37: / Line 37: @@
 * End files with a newline.
 * Commas should be followed by whitespace. Relations (=, <, <=, >=, ==, ~=) should have whitespace on each side.
-* if a conditional is to take up multiple lines, double indent the extra lines and end the line with a conjunction (See Gallery below)
+* if a conditional is to take up multiple lines, double indent the extra lines and end the line with a conjunction as shown: <gallery widths="329px">
 These guidelines are not necessarily followed in old files so updating them with a separate commit is a good idea prior to making large changes. Also, unitdefs use two-space indentation instead of tabs.
@@ Line 44: / Line 47: @@
 * Localisation of Spring.MoveCtrl.Function should be named spMoveCtrlFunction.
 * Spring.GetCommandQueue should be used rather than Spring.GetUnitCommands (it's an alias, we just picked one).
 == Getting sources ==
@@ Line 71: / Line 69: @@
 == Updating sources ==
-Keep your sources up to date by periodically syncing your fork to the original repository (using 'compare', see: https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser, then do "rebase and merge" instead of "merge") and doing TortoiseGit -> Pull on your repository folder to take the changes from GitHub to your local files.
+Keep your sources up to date by periodically syncing your fork to the original repository (using 'compare', see: https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser, then do "rebase and merge" instead of "merge") and doing TortoiseGit → Pull on your repository folder to take the changes from GitHub to your local files.
 == Modifying the game ==
@@ Line 82: / Line 80: @@
 * Launch Zero-K.exe.
 [[File:enableDevMode.jpg]]
-* Select 'Zero-K Dev' in Settings -> Developer -> Singleplayer (you may need to scroll down).
+* Select 'Zero-K Dev' in Settings → Developer → Singleplayer (you may need to scroll down).
 [[File:startTest.jpg]]
-* From the main menu select Singleplayer -> Skirmish -> Advanced -> Start to launch a test game. Note that the game type should be automatically set to 'Zero-K $VERSION'.
+* From the main menu select Singleplayer → Skirmish → Advanced → Start to launch a test game. Note that the game type should be automatically set to 'Zero-K $VERSION'.
 * In the game, press F8 to open debug console. It'll display errors and output to the log.
@@ Line 112: / Line 110: @@
 * Right click on 'zk.sdd' and select 'Git Commit'.
 * Write a description of the changes and click 'Commit'.
-* Right click on 'zk.sdd' and select TortiseGit -> Push.
+* Right click on 'zk.sdd' and select TortiseGit → Push.
 * Enter your GitHub login and password when prompted. The changes should now appear on your fork in GitHub.
 * Navigate to https://github.com/ZeroK-RTS/Zero-K/pulls and click "New Pull Request".
@@ Line 120: / Line 118: @@
 This creates a proposal to apply your changes to the main game. Be sure to check up on it and respond to comments.
-A more advanced method involves creating branches locally with TortiseGit -> Create Branch and committing blocks of related changes to a single branch. You are then able to make pull requests from branches. This allows branches to be smaller and more focused, which is desirable when merging.
+A more advanced method involves creating branches locally with TortiseGit → Create Branch and committing blocks of related changes to a single branch. You are then able to make pull requests from branches. This allows branches to be smaller and more focused, which is desirable when merging.
 Make sure to keep your repository up to date to make merges less difficult.
@@ Line 142: / Line 140: @@
 === Initializing Website Database ===
-You may need to setup the database connection for the website. In order to do that: Open Visual Studio, open the Server Explorer panel (under the View menu), right click Data Connections -> Add Connection -> Sql Server. Enter <code>(localdb)\mssqllocaldb</code> in the Server Name field, after which zero-k_local will appear in the dropdown list of databases.
+You may need to setup the database connection for the website. In order to do that: Open Visual Studio, open the Server Explorer panel (under the View menu), right click Data Connections → Add Connection → Sql Server. Enter <code>(localdb)\mssqllocaldb</code> in the Server Name field, after which zero-k_local will appear in the dropdown list of databases.
 (If zero-k_local does not appear, type it in the text box and press OK; Visual Studio will ask whether you would like to create the database. This may require you to have administrator rights on the computer.)
@@ Line 154: / Line 152: @@
 ** It's required that you install MS SQL Server on your local PC.
 *** You can get SQL Server 2019 (For Windows 10) [https://www.microsoft.com/en-us/sql-server/sql-server-downloads here] or SQL Server 2017 (for Windows 8 and later) [https://www.microsoft.com/en-us/sql-server/sql-server-2017 here] or SQL Server 2014 (for Windows 7) [https://www.microsoft.com/en-ie/download/details.aspx?id=42299 here]. For SQL Server 2014, the file you will need is called SQLEXPR_x64_ENU or SQLEXPR_x86_ENU. Make sure you install version that matches your version of Windows (i.e. x86 vs x64).
-*** During the installation, set collation to <code>SQL_Latin1_General_CP1_CI_AS</code>. Leave all the parameters default except that I changed server name to SQLSERVER in one of the first steps of wizard.
+*** During the installation, set collation to <code>SQL_Latin1_General_CP1_CI_AS</code>. Leave all the parameters default except that I changed server name to SQLSERVER in one of the first steps of wizard.[[File:SQL server collation.png|405px|none]]
-[[File:SQL server collation.png|405px]]
+** Right click asp.net → properties → web → check "Specific Page" and leave it blank. Otherwise you get errors when trying to host locally.
 ** Make sure SQL Server is running (check the Sql Server Configuration Manager in the Start Menu). If you can't connect, edit the data source for <code>ModeType.Local</code> in <code>GlobalConst.cs</code> (currently line 46) to say something like:<br/><code>Data Source=<hostname (usually your computer name)>\SQLSERVER</code>
 ** To make things run smoothly the following changes might also be a good idea: In <code>Shared/PlasmaShared/GlobalConst.cs</code> (currently line 137) replace the DefaultEngineOverride with whatever engine version is current. Comment out lines 190 and 238-298 of <code>Zero-K.info/AppCode/PlasmaServer.cs</code> unless somebody can supply instructions on how to make the torrent errors go away.