Skip to content

Commit

Permalink
Merge branch 'RetroAchievements:main' into qa-responsibilities
Browse files Browse the repository at this point in the history
  • Loading branch information
suspect15 authored Jul 20, 2024
2 parents 4617a13 + da2cbac commit 379c72e
Show file tree
Hide file tree
Showing 28 changed files with 138 additions and 117 deletions.
2 changes: 1 addition & 1 deletion docs/developer-docs/achievement-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,5 +280,5 @@ Challenge Achievements are your chance to show players how to play their favorit
## External Resources

- [Best practices achievement creation guide](http://www.voidcn.com/article/p-gmokauqn-bgh.html) written by Jeff Sullivan, Developer Account Manager of XNA Developer Connection (XDC) regarding XBox 360 Achievements.
- [Make them Work for it](https://gamedevelopment.tutsplus.com/articles/make-them-work-for-it-designing-achievements-for-your-games--gamedev-3371) an achievement design guide written by by Darran Jamieson on 1 Jan 2013.
- [Make them Work for it](https://gamedevelopment.tutsplus.com/articles/make-them-work-for-it-designing-achievements-for-your-games--gamedev-3371) an achievement design guide written by Darran Jamieson on 1 Jan 2013.
- [The Achievement Machine: Understanding Xbox 360 Achievements in Gaming Practices](http://gamestudies.org/1101/articles/jakobsson) - by Mikael Jakobsson
2 changes: 1 addition & 1 deletion docs/developer-docs/achievement-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ We want to award if the player finishes the level `N` while time is greater than

In this example we consider a game where there is no in-game timer to use for a speed run.

We want to award if the player finishes the level `N` before a a time `T` in the level, calculated as number of frames, has passed.
We want to award if the player finishes the level `N` before a time `T` in the level, calculated as number of frames, has passed.

| ID | Flag | Type | Memory | Cmp | Type | Mem/Val | Hits |
| --- | --------- | ----- | ------- | --- | ----- | ------- | -------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/console-specific-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Pointers always start with a `0x02`. For example, a pointer pointing directly to

### Mandatory UniBIOS protection

UniBIOS allows several debugging options, and also access the database of individual cheats for every game. Therefore all achievements for Neo Geo need to be protected from abusing it. The simpliest solution here is disallowing UniBIOS usage completely, directly from the level of achievement code.
UniBIOS allows several debugging options, and also access the database of individual cheats for every game. Therefore all achievements for Neo Geo need to be protected from abusing it. The simplest solution here is disallowing UniBIOS usage completely, directly from the level of achievement code.

Fortunately part of UniBIOS data seems to be reflected in two address strings in the RAM: `0x00fe30` and `0x00fe50`. While UniBIOS is active `0x00fe30` in 32-bit size seems to always brings the same value (for every Neo Geo game) which is `80025632`, and it doesn't seem to change after the ROM was loaded. For any other BIOS, the value is always 0, (except for the moment the RAM is overloaded by the diagnostic program, after the ROM was loaded).

Expand Down
29 changes: 14 additions & 15 deletions docs/developer-docs/devquests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

## What are DevQuests?

They're achievement development-related quests that Developers can take part in at any time. Each one has a specific goal and upon reaching that goal, the achievement developer will earn the badge. DevQuests are not available for Junior Developers.
DevQuests are achievement development-related quests that Developers can take part in at any time. Each one has a specific goal and upon reaching that goal, the achievement developer will earn the badge. DevQuests are not available for Junior Developers.

## General Rules

1. For Set-Creation achievements other than DevQuest 015 and DevQuest 020, announce your DQ pick in [`#devquest`](https://discord.com/channels/310192285306454017/310195377993416714) or via the DevQuest inbox on site early on in your development. This will give us time to make sure any issues with the choice can be sorted out early. Late requests may not be counted.
2. For Maintenance achievements (i.e.: DevQuest 001, DevQuest 005, DevQuest 04, etc), just create a column in the DevQuest Remastered sheet to the left of completed entries and fill it in as you work. Contact the DevQuest team when you are complete with all entries for review. For Maintenance Quests that can be repeated, one row of the column will be for which badge number you are working towards.
3. For Revision achievements (i.e.: DevQuest 002 and DevQuest 013), make sure your choice is already on the corresponding approved list. You will need to satisfy the repair plan. These quests should be more than simple one-achievement revisions. If a repair plan seems to be overly simple, contact us first to ensure it will qualify.
1. **Set-Creation Credit**: To be awarded credit for Set-Creation quests, contact the DevQuest Team via Discord ping in [`#devquest`](https://discord.com/channels/310192285306454017/842845740078334002) or via [site message](https://retroachievements.org/messages/create?to=DevQuest) within 1 week after publishing the set. Include a link to the game and which DevQuest it is being used for. (No need to do this for DevQuest 015 or 020 -- We handle those in sweeps separately). Note: Sets may still be disqualified for quality or rules reasons at this point. Contact us prior to release if you wish to confirm eligibility.
2. **Maintenance Quest Credit**: For maintenance achievements (i.e.: DevQuest 001, DevQuest 005, DevQuest 04, etc), just create a column in the DevQuest Remastered sheet to the left of completed entries and fill it in as you work. Contact the DevQuest team when you are complete with all entries for review. For Maintenance Quests that can be repeated, one row of the column will be for which badge number you are working towards.
3. **Revision Quest Credit**: For Revision achievements (i.e.: DevQuest 002 and DevQuest 013), make sure your choice is already on the corresponding approved list. You will need to satisfy the repair plan. These quests should be more than simple one-achievement revisions. If a repair plan seems to be overly simple, contact us first to ensure it will qualify. **When you start working on a revision quest, contact the DevQuest team** so the sheet can be updated; this lets other users know it is being worked on.
4. Unless otherwise stated in a DevQuest's description, collaborations are not allowed.
5. Standard set quality or better is expected for DevQuest sets. If a set appears to be of insufficient effort or a copy/paste set, it may be rejected at the DevQuest team's discretion. Rich Presence is required for DevQuest sets. The DevQuest team is happy to suggest improvements for qualification.
6. New sets may only be applied towards one Set Creation DevQuest. No double-dipping.
7. Always contact the active authors on sets whose content you will update or add to.

## Reporting

- Contact the team using the DevQuest team on site or on in [`#devquest`](https://discord.com/channels/310192285306454017/310195377993416714) on Discord.
- Contact the team using the DevQuest team via [site message](https://retroachievements.org/messages/create?to=DevQuest) or on in [`#devquest`](https://discord.com/channels/310192285306454017/842845740078334002) on Discord.

## Schedule and Announcements

Expand Down Expand Up @@ -46,7 +46,7 @@ They're achievement development-related quests that Developers can take part in
**Goal**: Repair 3 sets from provided batch
**Repeatable**: Yes (Up to 3 times)

1. Pick a game from the list of approved DQ2 sets and then post your claim to the [`#devquest`](https://discord.com/channels/310192285306454017/310195377993416714) channel on Discord or send to DevQuest inbox
1. Pick a game from the list of approved DQ2 sets and then post your claim to the [`#devquest`](https://discord.com/channels/310192285306454017/842845740078334002) channel on Discord or send to DevQuest inbox
2. Follow the revision process as normal: Post the plan on the forum, make a revision vote if any changes aren't on the "no need for approval list," and make a revision claim if adding achievements.
3. Resolve any open tickets for achievements kept in the set, Tickets for achievements being left demoted can be simply closed with reason of demotion cited
4. Revisions must fix everything specified in the repair plan. Contact the DevQuest team for any clarifications to what is included in the repair plan.
Expand Down Expand Up @@ -133,7 +133,7 @@ They're achievement development-related quests that Developers can take part in
- Amstrad CPC
- Arduboy
- WASM4
- Nintendo
- Nintendo DSi

::: warning NOTE
No hacks or homebrew unless those are the only types of games left without sets.
Expand All @@ -151,13 +151,12 @@ No hacks or homebrew unless those are the only types of games left without sets.
**Goal**: Develop a set for one of the most requested games
**Repeatable**: No

::: info Set Elligibility
::: info Set Eligibility
At the time you claim the set, it must be in Most Wanted section of the latest issue of RANews.
:::

1. If you already have one claimed when the game becomes eligible, you must be under 50% progress for it to count.
2. You must lock in your claim by posting to the [`#devquest`](https://discord.com/channels/310192285306454017/310195377993416714) channel onDiscord or sending a message to the DevQuest account.
3. Any games listed in the console-specific bonus section in RANews will only be eligible to be claimed in the month it was featured in, but the set doesn't need to be released in the same month.
2. Any games listed in the console-specific bonus section in RANews will only be eligible to be claimed in the month it was featured in, but the set doesn't need to be released in the same month.

### 008 [World Traveler](https://retroachievements.org/game/15918)

Expand Down Expand Up @@ -188,7 +187,7 @@ An English release is considered a game released in English in US, Canada, UK, o
**Repeatable**: No

- Must be a full set (to the extent of the games capabilities, See Watara vs PSP)
- Smaller consoles may be ruled inelligible
- Smaller consoles may be ruled ineligible

#### Current Launch Party Promotion Windows:
- Neo Geo CD: 2023-11-15 through 2024-05-15
Expand Down Expand Up @@ -246,7 +245,7 @@ An English release is considered a game released in English in US, Canada, UK, o
1. Choose from a provided list or grab one from a hub, just make sure you let us know when you start so we can mark it!
2. Must go through the revision process as per usual!
3. Make sure you take care with the set and don't just throw in a bunch of filler
4. Don't hestitate to contact us with any questions or suggestion<br>• This quest can be done multiple times (current limit: 3)
4. Don't hesitate to contact us with any questions or suggestion<br>• This quest can be done multiple times (current limit: 3)

### 014 [Laudable Leaderboards](https://retroachievements.org/game/862)

Expand Down Expand Up @@ -302,7 +301,7 @@ You must have developed sets for 10 or more supported platforms before opt-in. O
2. Must be full sets containing all content and challenges appropriate to the game.
3. The person that wrote the Wish This Set may not be one of the developers making the set.
4. Quest is available year round, and gets new games eligible every release of RANews.
5. If you already have a set claimed at the time it becomes elligible for this DevQuest you must be under 50% progress for it to count.
5. If you already have a set claimed at the time it becomes eligible for this DevQuest you must be under 50% progress for it to count.
6. Once a game has been featured it remains eligible until the game gets a set.


Expand All @@ -318,7 +317,7 @@ You must have developed sets for 10 or more supported platforms before opt-in. O
2. Must be full sets containing all content and challenges appropriate to the game.
3. No Homebrew/Hacks/Unlicensed
4. New sets only: No Multi Set or Revisions
5. Other picks are subject to DQ team approval if elligibility is questionable
5. Other picks are subject to DQ team approval if eligibility is questionable
7. Collaborations must be approved by the DevQuest team; games done via collaboration must have sufficient content or modes to justify qualifying.

### 018 [Subset Station](https://retroachievements.org/game/22564)
Expand Down Expand Up @@ -412,7 +411,7 @@ You must have made sets for at least 15 subgenres before opt-in. To opt-in, make
## Wheel Spin DevQuest Rules

1. You may respin 3 months after you spin. This requires and consumes your respin token for that quest
2. You start with one respin token (per aplicable DevQuest)
2. You start with one respin token (per applicable DevQuest)
3. Each wheel spin quest has its own kind of respin token (can't save your DevQuest 006 token for use in DevQuest 019)
3. You may not bank extra respin tokens
4. Once you have used your respin token, you may restore it by fulfilling one of the Respin Tasks, listed below
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/difficulty-scale-and-balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Very few player can get these on their first attempt, perhaps if they already kn

Only the rarest of players can complete these on a first attempt. Most can complete it after many attempts, Many players will drop off here and won't be willing to complete the set unless they are completionists or fans of the game. Many are not able to complete this after very many attempts. Usually takes significant practice, high skills, experience, research, or guides to complete.

**Examples:** Beating Contra in one life. Escaping Zebes (Super Metroid) in under two minutes. Beating many of the Megaman bosses without taking damage. Many damagless stages, depending on the game.
**Examples:** Beating Contra in one life. Escaping Zebes (Super Metroid) in under two minutes. Beating many of the Megaman bosses without taking damage. Many damageless stages, depending on the game.

### 6 - Super Hard

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Next we will change these values to the following:

With that set, we don't have any more conditions to add, so we return to the **Achievements Dialog**. To be safe, we should save our progress by hitting **Save Local**! This saves everything to file locally to ensure that we won't lose any progress.

- **Note**: An achievement should have more than one requirement to avoid it triggering at the wrong time (i.e. playing demo mode). In this example, we are using only one requirement to simplify the explanation. See more [Achievement Creation Tips here](/developer-docs/tips-and-tricks#achivement-creation-tips).
- **Note**: An achievement should have more than one requirement to avoid it triggering at the wrong time (i.e. playing demo mode). In this example, we are using only one requirement to simplify the explanation. See more [Achievement Creation Tips here](/developer-docs/tips-and-tricks#achievement-creation-tips).

## Testing the Achievement

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Any aspiring dev must demonstrate understanding of the following concepts:
- [Alt Groups](/developer-docs/alt-groups)
- Memory sizes: [8-bit](/developer-docs/memory-inspector#8-bit-mode) and [single bit](/developer-docs/memory-inspector#single-bits)
- Achievement logic comparisons besides `=`, such as `>`, `<`, `!=`
- [Adding badges to an achievment](/general/ways-to-contribute)
- [Adding badges to an achievement](/general/ways-to-contribute)
- [Creating accurate descriptions for achievements](/guidelines/developers/code-of-conduct#basic-achievement-design-guidelines)
- Add appropriate [protections](/developer-docs/getting-started-as-an-achievement-developer#important-tips)
- Make a [stable achievement set](/developer-docs/getting-started-as-an-achievement-developer#important-tips)
Expand Down
Loading

0 comments on commit 379c72e

Please sign in to comment.