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.

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

INI migration guide #483

Merged
merged 18 commits into from
Mar 3, 2024
Merged

INI migration guide #483

merged 18 commits into from
Mar 3, 2024

Conversation

MortonPL
Copy link
Member

This PR extends the migration guide with a step-by-step example INI configuration migration. It's aimed at YR modders, but most steps are applicable to any game using this client.

@github-actions
Copy link

github-actions bot commented Aug 26, 2023

Nightly build for this pull request:

Copy link
Member

@Metadorius Metadorius left a comment

Choose a reason for hiding this comment

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

We should update this to account for net48 revert and merge ASAP so that we could release the update for the masses.

@Metadorius
Copy link
Member

Also can you add an example on how to port one example checkbox or dropdown? something like "My cool game option" before and after migration, with all the relevant code. I think that would be more useful than the example config because the example configs could be found in the new mod base and/or TSCv6 which we should mention instead.

@MortonPL anything on that?

@MortonPL
Copy link
Member Author

MortonPL commented Mar 2, 2024

It's there, see paragraph "Port custom game options" (lines 543-580). There isn't really much to do, though.

@Metadorius
Copy link
Member

It's there, see paragraph "Port custom game options" (lines 543-580). There isn't really much to do, though.

Ah the syntax highlighting broke so I didn't notice, pardon. Then I don't have much complaints, let's address the remaining feedback from Rampa and SadPencil and merge.

@MortonPL MortonPL marked this pull request as draft March 3, 2024 14:53
@MortonPL MortonPL marked this pull request as ready for review March 3, 2024 19:13
Copy link
Member

@Metadorius Metadorius left a comment

Choose a reason for hiding this comment

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

Apart from manual line breaks and the comment below I see no issues, great job.

@Metadorius Metadorius merged commit f89c8fc into CnCNet:develop Mar 3, 2024
3 checks passed
@MortonPL MortonPL deleted the migration-guide branch March 6, 2024 15:31
SadPencil added a commit to SadPencil/xna-cncnet-client that referenced this pull request Oct 4, 2024
* Add second migration guide

* Update Migration-INI.md

* Add mention in the main migration guide

* Update Migration-INI.md

* Add extra empty lines between headers and code blocks

* Reference a specific mod base commit, revert .NET 7 changes

* Make large code blocks collapsible, add more descriptions

* Refer to the new version as 2.11.0.0

* Mention .NET 8 binaries again

* Reorder paragraphs

* Enforce 80 character line width

* Don't use the word "root" when referring to the game directory root

* Make .NET 8 build not optional

* Mention the second stage updater

* Stash

* Ensure that the migration guide works

* Add directory tree view  for executables

* Remove hard line wrap

---------

Co-authored-by: SadPencil <[email protected]>
SadPencil added a commit to SadPencil/xna-cncnet-client that referenced this pull request Oct 4, 2024
* Add second migration guide

* Update Migration-INI.md

* Add mention in the main migration guide

* Update Migration-INI.md

* Add extra empty lines between headers and code blocks

* Reference a specific mod base commit, revert .NET 7 changes

* Make large code blocks collapsible, add more descriptions

* Refer to the new version as 2.11.0.0

* Mention .NET 8 binaries again

* Reorder paragraphs

* Enforce 80 character line width

* Don't use the word "root" when referring to the game directory root

* Make .NET 8 build not optional

* Mention the second stage updater

* Stash

* Ensure that the migration guide works

* Add directory tree view  for executables

* Remove hard line wrap

---------

Co-Authored-By: SadPencil <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants