Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix build props and improve docs #419

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Fix build props and improve docs #419

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
146e3a5
Exclude "Binaries*" & fix YR game files' condition in build props
pzhlkj6612 Jan 7, 2025
0a465fe
Improve development docs
pzhlkj6612 Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ This package is an add-on to the [XNA CnCNet Client](https://github.com/CnCNet/x

**NOTE:** This is NOT the repository necessary for developing the CnCNet client for Yuri's revenge. That is the **XNA CnCNet Client** mentioned above. This is simply a wrapper for it.

To contribute to the XNA client for YR, you must also check out the `xna-cncnet-client` repo mentioned above. Once that repo is checked out, you can copy and paste the `Directory.Build.Game.YR.props` file located into the `resources` folder of the `cncnet-yr-client-package` checkout location to the root of the `xna-cncnet-client` checkout location. This file should automatically copy over all necessary resources from this repository to the output directory of the compiled `xna-cncnet-client` executable. Then, when launched, it should do so with with the Yuri's revenge theme.
brichardson1991 marked this conversation as resolved.
Show resolved Hide resolved
To contribute to the XNA client for YR, you must also check out the `xna-cncnet-client` repo mentioned above. Once that repo is checked out, you can copy and paste the `Directory.Build.Game.YR.props` file located into the `resources` folder of the `cncnet-yr-client-package` checkout location to the root of the `xna-cncnet-client` checkout location. This file should automatically copy over all necessary resources from this repository to the output directory of the compiled `xna-cncnet-client` executable. Then, when launched, it should do so with the Yuri's revenge theme.

You MUST edit the `YRSource` property in the `Directory.Build.Game.YR.props` file if you use it.
You MUST edit the `YRSource` property in the `Directory.Build.Game.YR.props` file before using it.
pzhlkj6612 marked this conversation as resolved.
Show resolved Hide resolved

### Repository Structure

Expand Down
2 changes: 1 addition & 1 deletion resources/Directory.Build.Game.YR.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ so that the client starts up with the YR theme.
<PropertyGroup>
<!--
Change the value of YRSource to wherever you have the YR client repo checked out OR
you can use your installation path of YR for cncnet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fine as is, i think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey, @brichardson1991! thank you for reviewing my changes.


Change the value of YRSource to wherever you have the YR client repo checked out OR you can use your installation path of YR for cncnet.

the original sentence sounds a bit odd to my non-native ears. that sentence, i think, means that we have two choices about specifying the path:

  • the one is my checked-out YR client repo.
  • the other is my YR installation.

to be simplified, that's "change A to B or C" or "change A to B or change A to C". here the "you can use" looks being placed in a wrong location, so i've deleted it.

your opinion?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty much yes, we are stating use the one where you've just checked the repository out to or your game installation directory.

The language used at present is fine, but I guess for non-english native it's a bit harder to interpret.

The easiest thing would be

<!-- 
            Change the value of YRSource to wherever you have the YR client repo checked out OR
            you can use your installation path of YR for cncnet. For example:
            C:\repos\cncnet-yr-client-package\ or 
            C:\SteamLibrary\steamapps\common\Command & Conquer Red Alert II\
--!>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Adding examples looks better.

Maybe I can rewrite it like this (comparing with the original):

         <PropertyGroup>
             <!--
             Change the value of YRSource to wherever you have the YR client repo checked out OR
             you can use your installation path of YR for cncnet.
-            This path should be the same one that contains the file "gamemd.exe".

-            Example: c:\repos\cncnet-yr-client-package\package
+            Examples:
+            - c:\repos\cncnet-yr-client-package\package
+            - c:\Westwood\RA2
             -->
             <YRSource></YRSource>

             <!--
             OPTIONAL
             Change the value of YRGameInstallSource to wherever you have the game installed locally.
-            This is only necessary if YRSource above is not already set to the game installation path and
+            This is only necessary if YRSource above is not already set to the game installation path (containing "gamemd.exe") and
             you need to be able to launch the game from the client during development/while using the YR client repo for YRSource.

             Example: c:\ra2InstallPath\Command and Conquer Red Alert II
             -->
             <YRGameInstallSource></YRGameInstallSource>

Explanation:

  • "c:\Westwood\RA2": I think that the game from Steam is not a "YR for cncnet" without modification, so I use the default installation path of "CnCNet5_YR_Installer.exe". The code is at

    cncnet-yr-client-package/tools/build-installer/inno/installer.twig

    Line 13 in b0b7ea8

    DefaultGamePathEng=C:\Westwood\RA2\
  • About "gamemd.exe": we have no game files in YR client repo, so don't mislead new developers to try to copy them to the "package" directory in this repository and then face a bunch of untracked files. Yeah, I did it before.
  • Lowercase drive letters, missing trailing backslashes and other changes: consistent style.

Do you like this? 😁

your installation path of YR for cncnet.
This path should be the same one that contains the file "gamemd.exe".

Example: c:\repos\cncnet-yr-client-package\package
Expand Down