From bedabdf53d90add3ce40f146e5ac50094af3f1d7 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 14 Jul 2024 00:13:01 -0400 Subject: [PATCH] Added missing changelog for 0.3.0 and 0.4.0 (#71) --- .../workflows/pack-randomizer-release.yaml | 2 +- .github/workflows/pack-randomizer.yaml | 2 +- .markdownlint.jsonc | 4 + .../Entrance Randomizer/CHANGELOG.md | 79 ++++++++++++++++++- .../newsfragments/.gitignore | 1 + .../newsfragments/65.feature.md | 1 + .../newsfragments/69.doc.md | 1 + .../newsfragments/70.doc.md | 2 +- .../newsfragments/87.feature.md | 1 + Dolphin scripts/pack-rando.ps1 | 2 +- Dolphin scripts/version-bump.ps1 | 2 +- 11 files changed, 90 insertions(+), 7 deletions(-) create mode 100644 .markdownlint.jsonc create mode 100644 Dolphin scripts/Entrance Randomizer/newsfragments/.gitignore create mode 100644 Dolphin scripts/Entrance Randomizer/newsfragments/65.feature.md create mode 100644 Dolphin scripts/Entrance Randomizer/newsfragments/69.doc.md create mode 100644 Dolphin scripts/Entrance Randomizer/newsfragments/87.feature.md diff --git a/.github/workflows/pack-randomizer-release.yaml b/.github/workflows/pack-randomizer-release.yaml index a67b345..bbd93a1 100644 --- a/.github/workflows/pack-randomizer-release.yaml +++ b/.github/workflows/pack-randomizer-release.yaml @@ -21,7 +21,7 @@ env: FORCE_COLOR: 1 jobs: - pack-randomizer: + pack: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/pack-randomizer.yaml b/.github/workflows/pack-randomizer.yaml index 2bed7d1..047fb6f 100644 --- a/.github/workflows/pack-randomizer.yaml +++ b/.github/workflows/pack-randomizer.yaml @@ -24,7 +24,7 @@ env: FORCE_COLOR: 1 jobs: - pack-randomizer: + pack: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..ce4064d --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,4 @@ +{ + "MD041": false, + "MD013": false, +} diff --git a/Dolphin scripts/Entrance Randomizer/CHANGELOG.md b/Dolphin scripts/Entrance Randomizer/CHANGELOG.md index 4888f35..c7a7169 100644 --- a/Dolphin scripts/Entrance Randomizer/CHANGELOG.md +++ b/Dolphin scripts/Entrance Randomizer/CHANGELOG.md @@ -12,11 +12,86 @@ Minor: Affects seed Patch: Does't affect seed (assuming same settings) ``` -This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in . +This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in [newsfragments](./newsfragments). To add a changelog entry, add a new file `..md` to the `newsfragments` folder. (See the different [fragment types](https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragments)) -## 5.0.0 - 2024-07-13 +## 0.4.0 - 2024-07-13 + +### Features + +- - Add back crash site now that we can avoid the default entrance that resets progression + - Added back teleporters as they're possibly fixed to activate when entering the right entrance + - Add more info on-screen and in logs about entrances and unrandomized transitions + + -- by @Avasam ([#37](https://github.com/Avasam/ptle-tools/issues/37)) +- - Guaranteed that if `CONFIGS.LINKED_TRANSITIONS == True` then all connections in the game are actually 2-way with the correct entrances + - Added all four basic 1-way transitions (the geysers for instance) to the randomization process and made them randomized as well + - Added Algorithm that guarantees that if `CONFIGS.LINKED_TRANSITIONS == True` then all levels are linked together in 1 big map, preventing any levels from being disconnected from the rest and therefore becoming unreachable + - Updated transition_infos.json to include all levels in the entire game (even the one's we're not randomizing yet) + - Updated list of levels we do NOT want to randomly pick as our starting_area + + -- by @wossnameGitHub ([#40](https://github.com/Avasam/ptle-tools/issues/40)) +- Add graph of connections in `.graphml` format -- by @wossnameGitHub ([#42](https://github.com/Avasam/ptle-tools/issues/42)) +- Added option to keep Jag1 & Jag2, or to skip jaguar fights entirely -- by @wossnameGitHub ([#45](https://github.com/Avasam/ptle-tools/issues/45)) +- - No longer spoiling the start area in the UI as it doesn't affect randomization anymore + - Added anti-softlock from missing items in Apu Illapu Shrine (Spinjas) and Scorpion Temple + - Prevent starting area being a cutscene, Native Minigame, or Twin Outpost + + -- by @Avasam ([#49](https://github.com/Avasam/ptle-tools/issues/49)) + +### Bugfixes + +- - Added anti-softlock from running into closed doors by bumping Harry's height in certain entrances + - Fix `global _shaman_shop_prices` error + + -- by @Avasam ([#37](https://github.com/Avasam/ptle-tools/issues/37)) + - Fix altar of ages not being accessible (made rando impossible) + - Fix non-existant transitions in list (could lead to impossible seed) + + -- by @wossnameGitHub ([#37](https://github.com/Avasam/ptle-tools/issues/37)) +- - St. Claire's Camp bugfix (now Day & Night works properly, and the Rando is now proven to be fully functional New Game until Credits) + - added 2 missing transitions (Twin Outposts -> Turtle Monument & Crystal Cavern -> Abandoned Cavern) + + -- by @wossnameGitHub ([#40](https://github.com/Avasam/ptle-tools/issues/40)) +- Improve starting area randomization: + + - Manual vs random starting area won't affect the seed + - Remove more unwanted starting areas possibilities + + -- by @wossnameGitHub ([#47](https://github.com/Avasam/ptle-tools/issues/47)) + +### Improved Documentation + +- Improve various texts: + + - Fixed displaying non-random starting area + - Changed how transition mapping is written in spoiler logs + - Added rando features and more known issues to the readme + - Fixed a few typos + + -- by @Avasam & @wossnameGitHub ([#46](https://github.com/Avasam/ptle-tools/issues/46)) + +### Deprecations and Removals + +- Temporarily removed 3 levels from the rando pool (Scorpion Temple (Harry), Mouth of Inti, Twin Outposts (Underwater)) -- by @wossnameGitHub ([#40](https://github.com/Avasam/ptle-tools/issues/40)) +- No longer spoiling the start area in the UI as it doesn't affect randomization anymore -- by @Avasam ([#49](https://github.com/Avasam/ptle-tools/issues/49)) + +### Misc + +- [#43](https://github.com/Avasam/ptle-tools/issues/43) + +## 0.3.0 - 2023-03-17 + +- Now comes with a readme! +- Linked transitions should now be a thing, although: "Non-vanilla transitions will always spawn Harry at the default entrance. This can be a bit confusing when using linked transitions." +- Crash Site and Teleports have been taken out of randomization (even if I could randomize at least the exits in non-linked transitions, I decided it's easier for now to just keep them vanilla) +- The Altar of Ages shortcut back to BBCamp after the cutscene from the first visit has been disabled. This standardizes exits. +- St. Claire's Excavation Camp Day and Night are now considered the same map for the Randomizer. And visiting Altar of Ages to get night camp is now enforced. +- Removed St. Claire's Excavation Camp, Apu Illapu Shrine (aka Spinjas) and Scorpion Temple from possible random starting areas (avoids immediate impossible seeds and getting TNT as your first area). +- Added Spoiler logs! (should be under dolphin-scripting-preview2/User/Logs, check Dolphin logs to see the exact location). You can now validate the seed is even possible. If a transition isn't listed in the spoiler log, it's vanilla. + +Other than that, still no logic, this prototype is still mainly focused on exploring possibilities, finding issues and edgecases. diff --git a/Dolphin scripts/Entrance Randomizer/newsfragments/.gitignore b/Dolphin scripts/Entrance Randomizer/newsfragments/.gitignore new file mode 100644 index 0000000..2f550f6 --- /dev/null +++ b/Dolphin scripts/Entrance Randomizer/newsfragments/.gitignore @@ -0,0 +1 @@ +# This only exists to keep this folder in git. Even when empty. diff --git a/Dolphin scripts/Entrance Randomizer/newsfragments/65.feature.md b/Dolphin scripts/Entrance Randomizer/newsfragments/65.feature.md new file mode 100644 index 0000000..1d197ae --- /dev/null +++ b/Dolphin scripts/Entrance Randomizer/newsfragments/65.feature.md @@ -0,0 +1 @@ +"Immediate spirit fights" is optional and configurable -- by @Avasam diff --git a/Dolphin scripts/Entrance Randomizer/newsfragments/69.doc.md b/Dolphin scripts/Entrance Randomizer/newsfragments/69.doc.md new file mode 100644 index 0000000..c756066 --- /dev/null +++ b/Dolphin scripts/Entrance Randomizer/newsfragments/69.doc.md @@ -0,0 +1 @@ +Development versions are now automatically packed and uploaded as artefacts. Link added to readme. -- by @Avasam diff --git a/Dolphin scripts/Entrance Randomizer/newsfragments/70.doc.md b/Dolphin scripts/Entrance Randomizer/newsfragments/70.doc.md index 333a45f..077dc1a 100644 --- a/Dolphin scripts/Entrance Randomizer/newsfragments/70.doc.md +++ b/Dolphin scripts/Entrance Randomizer/newsfragments/70.doc.md @@ -1 +1 @@ -Initialized the changelog using Towncrier -- by @Avasam +Initialized the changelog using Towncrier & automatically pack release versions -- by @Avasam diff --git a/Dolphin scripts/Entrance Randomizer/newsfragments/87.feature.md b/Dolphin scripts/Entrance Randomizer/newsfragments/87.feature.md new file mode 100644 index 0000000..8b2e89a --- /dev/null +++ b/Dolphin scripts/Entrance Randomizer/newsfragments/87.feature.md @@ -0,0 +1 @@ +When being sent to an Animal Temple that you haven't beaten yet, you will now instead be redirected to the Spirit Fight immediately -- by @wossnameGitHub diff --git a/Dolphin scripts/pack-rando.ps1 b/Dolphin scripts/pack-rando.ps1 index 3729e69..9ca79a8 100644 --- a/Dolphin scripts/pack-rando.ps1 +++ b/Dolphin scripts/pack-rando.ps1 @@ -21,4 +21,4 @@ else { $VersionFileContent -replace '^\s*__dev_version.*', "__dev_version = `"$DevVersion`"" | Set-Content $VersionFilePath Compress-Archive -Path $ScriptsFolder -DestinationPath "$RandoFolderName v$RandoVersion-$DevVersion.zip" -Force -Remove-Item -Path $ScriptsFolder -Recurse +Remove-Item -Path $ScriptsFolder -Recurse -ErrorAction SilentlyContinue diff --git a/Dolphin scripts/version-bump.ps1 b/Dolphin scripts/version-bump.ps1 index 5a55385..19eaf67 100644 --- a/Dolphin scripts/version-bump.ps1 +++ b/Dolphin scripts/version-bump.ps1 @@ -5,4 +5,4 @@ $RandoVersion = Read-Host 'Version number (X.X.X)' $VersionFileContent = Get-Content $VersionFilePath $VersionFileContent -replace '^\s*__version = .*', "__version = `"$RandoVersion`"" | Set-Content $VersionFilePath -towncrier build --draft --version $RandoVersion +towncrier build --yes --version $RandoVersion