From 9c29f09f9d5700bebaf3c61304d2078ad45e83bf Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Fri, 2 May 2025 10:06:13 -0400 Subject: [PATCH 1/9] Adds set development and revision rules for games with parallel releases. --- docs/.vitepress/config/en.ts | 4 +++ docs/.vitepress/config/es.ts | 4 +++ docs/.vitepress/config/pt.ts | 4 +++ .../content/achievement-set-revisions.md | 4 +++ .../content/games-with-parallel-releases.md | 30 +++++++++++++++++++ docs/guidelines/developers/claims-system.md | 16 ++++++++++ 6 files changed, 62 insertions(+) create mode 100644 docs/guidelines/content/games-with-parallel-releases.md diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index d168d253..4ecfa46d 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -234,6 +234,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { text: "Player Compatibility Testing", link: "/guidelines/content/player-compatibility-testing", }, + { + text: "Games With Parallel Releases", + link: "/guidelines/content/games-with-parallel-releases", + }, { text: "Achievements for ROM Hacks", link: "/guidelines/content/achievements-for-rom-hacks", diff --git a/docs/.vitepress/config/es.ts b/docs/.vitepress/config/es.ts index c8d9e97e..e88511d2 100644 --- a/docs/.vitepress/config/es.ts +++ b/docs/.vitepress/config/es.ts @@ -246,6 +246,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { // text: "Player Compatibility Testing", // link: "/guidelines/content/player-compatibility-testing", // }, + //{ + // text: "Games With Parallel Releases", + // link: "/guidelines/content/games-with-parallel-releases", + //}, { text: "Logros para ROM Hacks", link: "/es/guidelines/content/achievements-for-rom-hacks", diff --git a/docs/.vitepress/config/pt.ts b/docs/.vitepress/config/pt.ts index 6f227b90..3b23809f 100644 --- a/docs/.vitepress/config/pt.ts +++ b/docs/.vitepress/config/pt.ts @@ -247,6 +247,10 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { // link: "/guidelines/content/player-compatibility-testing", // }, // { + // text: "Games With Parallel Releases", + // link: "/guidelines/content/games-with-parallel-releases", + // }, + // { // text: "Conquistas para ROM Hacks", // link: "/pt/guidelines/content/achievements-for-rom-hacks", // }, diff --git a/docs/guidelines/content/achievement-set-revisions.md b/docs/guidelines/content/achievement-set-revisions.md index 30da95a9..646a8906 100644 --- a/docs/guidelines/content/achievement-set-revisions.md +++ b/docs/guidelines/content/achievement-set-revisions.md @@ -45,6 +45,10 @@ Any developer wanting to revise a set needs to: 3. **Post the plan** in the game's forum topic. **NOTE**: Be as specific as possible. The community deserves a good understanding of your intent. +::: danger Un-Merging Parallel Release Sets +Games with parallel releases whose base sets are currently merged together (Example: *Pokémon Red Version | Pokemon Blue Version*) may be un-merged into separate sets, but doing so has additional requirements beyond a standard revision. Please see the full rules in the [Games With Parallel Releases](/guidelines/content/games-with-parallel-releases) document. +::: + 4. **Start a Discussion** by creating a new post in `#revision-discussion-forum`. - Your post title should include the game name and console. Ex: "Revision proposal - Super Mario Bros. (NES)" diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md new file mode 100644 index 00000000..1a1eec79 --- /dev/null +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -0,0 +1,30 @@ +--- +title: Games with Parallel Releases +description: Guidelines for handling games with parallel releases on RetroAchievements, including how new achievement sets should be created and how current achievement sets should be revised. +--- + +# Games with Parallel Releases + +Some games have multiple versions that were released simultaneously in-parallel and are designed to interact with each other but offer differing play experiences while remaining at their core the same game. Ex: Mainline Pokemon games. + +::: tip Retail Games Only +This policy only applies to retail games. Hacks with parallel releases shall not have separate sets unless there are significant differences, subject to approval by the Developer Compliance team. +::: + +[[toc]] + +## What Sets Can They Have? + +- Each version shall have its own set. +- Each version’s set shall have a different author. +- Sets whose versions were merged into one core set before this policy entered effect may remain merged. + +## Can We Un-Merge Existing Sets? + +Unmerging shall be allowed if a game currently has a merged core set, under the following requirements: + +- The author of the merged core set shall be given preference as to which version their work shall become. +- Version-specific achievements in the merged core set shall be transferred with authorship intact to the other version upon unmerge. +- The unmerge plan must be approved by the Developer Compliance team, with input from the QA-Maintainers team. +- A satisfactory plan for how to handle unlocks for players that have earned the merged set achievements must be developed and approved. +- Must pass a revision vote. \ No newline at end of file diff --git a/docs/guidelines/developers/claims-system.md b/docs/guidelines/developers/claims-system.md index 452d7c99..be34ab55 100644 --- a/docs/guidelines/developers/claims-system.md +++ b/docs/guidelines/developers/claims-system.md @@ -78,3 +78,19 @@ Each developer is allowed four primary claims. Junior developers are allowed one ## Important Notes - It is recommended that you post a complete plan in the forum topic. When doing so, be open to suggestions; you can get excellent input and suggestions this way. + +## Special Cases + +### Hacks + +Refer to the [Achievements for ROM Hacks](/guidelines/content/achievements-for-rom-hacks) document for full information. + +- May not make a set claim for a cosmetic hack; these can likely just be linked to the base set with proper testing. +- May not make a set claim for a simple QOL hack that does not significantly change the gameplay. + +### Games with Parallel Releases + +Refer to the [Games With Parallel Releases](/guidelines/content/games-with-parallel-releases) document for full information. + +- You may not claim a merged set. Example: May not make a claim for *Pokémon Black Version | Pokemon White Version*. These releases must have separate sets. +- You may not claim a parallel version of a game for which you've already made another set. Example: Cannot make a set for [Pokémon White](https://retroachievements.org/game/16211) if you have claim for or already made a set for [Pokémon Black](https://retroachievements.org/game/3887) From 35d7b5f826098fc862459d59b27a93b0d7426055 Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Fri, 2 May 2025 11:07:21 -0400 Subject: [PATCH 2/9] Updated a header to avoid future confusion with 'Special Claims' rules. --- docs/guidelines/developers/claims-system.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/developers/claims-system.md b/docs/guidelines/developers/claims-system.md index be34ab55..50a6e965 100644 --- a/docs/guidelines/developers/claims-system.md +++ b/docs/guidelines/developers/claims-system.md @@ -79,7 +79,7 @@ Each developer is allowed four primary claims. Junior developers are allowed one - It is recommended that you post a complete plan in the forum topic. When doing so, be open to suggestions; you can get excellent input and suggestions this way. -## Special Cases +## Additional Rules for Specific Types of Sets ### Hacks From 7fa2df2559aea1be3387c6fff6da027d73bcb1e2 Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Fri, 2 May 2025 14:36:58 -0400 Subject: [PATCH 3/9] Making it clearer which categories of games do not apply. --- docs/guidelines/content/games-with-parallel-releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index 1a1eec79..a84bf7b0 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -8,7 +8,7 @@ description: Guidelines for handling games with parallel releases on RetroAchiev Some games have multiple versions that were released simultaneously in-parallel and are designed to interact with each other but offer differing play experiences while remaining at their core the same game. Ex: Mainline Pokemon games. ::: tip Retail Games Only -This policy only applies to retail games. Hacks with parallel releases shall not have separate sets unless there are significant differences, subject to approval by the Developer Compliance team. +This policy only applies to licensed retail games. Other categories of games, such as hacks, shall not have separate sets for parallel releases unless there are significant differences, subject to approval by the Developer Compliance team. ::: [[toc]] From 5f5487646baf25794f3eb5f259bb92448ce643ad Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Wed, 14 May 2025 09:26:39 -0400 Subject: [PATCH 4/9] Replace 'core set' with the more correct 'base set' --- docs/guidelines/content/games-with-parallel-releases.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index a84bf7b0..7fe66452 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -17,14 +17,14 @@ This policy only applies to licensed retail games. Other categories of games, su - Each version shall have its own set. - Each version’s set shall have a different author. -- Sets whose versions were merged into one core set before this policy entered effect may remain merged. +- Sets whose versions were merged into one base set before this policy entered effect may remain merged. ## Can We Un-Merge Existing Sets? -Unmerging shall be allowed if a game currently has a merged core set, under the following requirements: +Unmerging shall be allowed if a game currently has a merged base set, under the following requirements: -- The author of the merged core set shall be given preference as to which version their work shall become. -- Version-specific achievements in the merged core set shall be transferred with authorship intact to the other version upon unmerge. +- The author of the merged base set shall be given preference as to which version their work shall become. +- Version-specific achievements in the merged base set shall be transferred with authorship intact to the other version upon unmerge. - The unmerge plan must be approved by the Developer Compliance team, with input from the QA-Maintainers team. - A satisfactory plan for how to handle unlocks for players that have earned the merged set achievements must be developed and approved. - Must pass a revision vote. \ No newline at end of file From 448cf396fdfc37a5cb461b9128b2b34438e7ce5f Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Tue, 27 May 2025 09:14:54 -0400 Subject: [PATCH 5/9] Added text for how to handle a cause where original merged set author is no longer able to be contacted. Other minor fixes. --- docs/guidelines/content/games-with-parallel-releases.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index 7fe66452..f95f1ca3 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -23,8 +23,9 @@ This policy only applies to licensed retail games. Other categories of games, su Unmerging shall be allowed if a game currently has a merged base set, under the following requirements: -- The author of the merged base set shall be given preference as to which version their work shall become. +- The author(s) of the merged base set shall be given preference as to which version their work shall become. + - If no longer able to be contacted, use best judgement when presenting the unmerge plan, paying attention to any written record that may indicate preference. - Version-specific achievements in the merged base set shall be transferred with authorship intact to the other version upon unmerge. - The unmerge plan must be approved by the Developer Compliance team, with input from the QA-Maintainers team. - A satisfactory plan for how to handle unlocks for players that have earned the merged set achievements must be developed and approved. -- Must pass a revision vote. \ No newline at end of file +- Must pass a standard revision vote. \ No newline at end of file From b92b343ce160a6d429893bb12c8145a6c2d3554a Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Tue, 27 May 2025 11:24:33 -0400 Subject: [PATCH 6/9] Reworded opening per Nepiki's suggestion. Added a condition that the sets should vary from each other. --- docs/guidelines/content/games-with-parallel-releases.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index f95f1ca3..e7c879db 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -5,7 +5,7 @@ description: Guidelines for handling games with parallel releases on RetroAchiev # Games with Parallel Releases -Some games have multiple versions that were released simultaneously in-parallel and are designed to interact with each other but offer differing play experiences while remaining at their core the same game. Ex: Mainline Pokemon games. +Some games have multiple versions that were released simultaneously in-parallel and are designed to interact with each other, remaining at their core the same game yet offering differing play experiences. Ex: Mainline Pokemon games. ::: tip Retail Games Only This policy only applies to licensed retail games. Other categories of games, such as hacks, shall not have separate sets for parallel releases unless there are significant differences, subject to approval by the Developer Compliance team. @@ -16,7 +16,8 @@ This policy only applies to licensed retail games. Other categories of games, su ## What Sets Can They Have? - Each version shall have its own set. -- Each version’s set shall have a different author. +- Each version's set shall have a different author. +- Each version's set shall vary from each other, especially having achievements that highlight the differences between each set. - Sets whose versions were merged into one base set before this policy entered effect may remain merged. ## Can We Un-Merge Existing Sets? From 437d851e8730d915a183dce2869844e64787cf24 Mon Sep 17 00:00:00 2001 From: Matt Buchwald Date: Tue, 27 May 2025 13:46:19 -0400 Subject: [PATCH 7/9] Updated unique sets clause wording --- docs/guidelines/content/games-with-parallel-releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index e7c879db..1c6da280 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -17,7 +17,7 @@ This policy only applies to licensed retail games. Other categories of games, su - Each version shall have its own set. - Each version's set shall have a different author. -- Each version's set shall vary from each other, especially having achievements that highlight the differences between each set. +- Each version's set must be unique from the others, while still covering all content available, highlighting differences between games with unique and creative achievements. - Sets whose versions were merged into one base set before this policy entered effect may remain merged. ## Can We Un-Merge Existing Sets? From d654c9ccbbf776d35522c3c3be8f07927e6722d1 Mon Sep 17 00:00:00 2001 From: Wes Copeland Date: Mon, 9 Jun 2025 18:54:40 -0400 Subject: [PATCH 8/9] Update docs/guidelines/content/games-with-parallel-releases.md --- docs/guidelines/content/games-with-parallel-releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index 1c6da280..bc1efa0e 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -5,7 +5,7 @@ description: Guidelines for handling games with parallel releases on RetroAchiev # Games with Parallel Releases -Some games have multiple versions that were released simultaneously in-parallel and are designed to interact with each other, remaining at their core the same game yet offering differing play experiences. Ex: Mainline Pokemon games. +Some games have multiple versions that were released simultaneously in parallel and are designed to interact with each other, remaining at their core the same game yet offering differing play experiences. Ex: Mainline Pokemon games. ::: tip Retail Games Only This policy only applies to licensed retail games. Other categories of games, such as hacks, shall not have separate sets for parallel releases unless there are significant differences, subject to approval by the Developer Compliance team. From d235e8b4f269a3a79708dad88a4dfe04b60bcb32 Mon Sep 17 00:00:00 2001 From: Wes Copeland Date: Mon, 9 Jun 2025 18:54:44 -0400 Subject: [PATCH 9/9] Update docs/guidelines/content/games-with-parallel-releases.md --- docs/guidelines/content/games-with-parallel-releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/content/games-with-parallel-releases.md b/docs/guidelines/content/games-with-parallel-releases.md index bc1efa0e..d5aa6604 100644 --- a/docs/guidelines/content/games-with-parallel-releases.md +++ b/docs/guidelines/content/games-with-parallel-releases.md @@ -25,7 +25,7 @@ This policy only applies to licensed retail games. Other categories of games, su Unmerging shall be allowed if a game currently has a merged base set, under the following requirements: - The author(s) of the merged base set shall be given preference as to which version their work shall become. - - If no longer able to be contacted, use best judgement when presenting the unmerge plan, paying attention to any written record that may indicate preference. + - If no longer able to be contacted, use best judgment when presenting the unmerge plan, paying attention to any written record that may indicate preference. - Version-specific achievements in the merged base set shall be transferred with authorship intact to the other version upon unmerge. - The unmerge plan must be approved by the Developer Compliance team, with input from the QA-Maintainers team. - A satisfactory plan for how to handle unlocks for players that have earned the merged set achievements must be developed and approved.