Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 0 deletions docs/.vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ function sidebarGeneral(): DefaultTheme.SidebarItem[] {
text: "Quality Assurance",
link: "/general/teams/qa-team",
},
{
text: "DevQuest",
link: "/general/teams/devquest-team",
},
],
},
{
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/config/es.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ function sidebarGeneral(): DefaultTheme.SidebarItem[] {
// text: "Control de calidad",
// link: "/general/teams/qa-team",
// },
// {
// text: "DevQuest",
// link: "/general/teams/devquest-team",
// },
// ],
//},
// {
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/config/pt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ function sidebarGeneral(): DefaultTheme.SidebarItem[] {
// text: "Quality Assurance",
// link: "/general/teams/qa-team",
// },
// {
// text: "DevQuest",
// link: "/general/teams/devquest-team",
// },
// ],
// },
{
Expand Down
14 changes: 0 additions & 14 deletions docs/.wip/Docs-To-Do-List.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/.wip/WIP-Content-Guidelines.md

This file was deleted.

36 changes: 0 additions & 36 deletions docs/.wip/WIP-Overview.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/.wip/WIP-‐-How-Does-RetroAchievements-Work.md

This file was deleted.

18 changes: 6 additions & 12 deletions docs/developer-docs/getting-started-as-an-achievement-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The Memory Inspector can be used to find addresses in RAM for us to use. Essenti
**NOTE: If you want a step-by-step video explanation on finding memory addresses, you can [view this updated video](https://www.youtube.com/watch?v=7ZMlBVyHl5M).**
**For another video resource, you can [view this older video](https://www.youtube.com/watch?v=8nYb_5cgQHY)**.

**See also**: [Memory Inspector Overview](/developer-docs/memory-inspector) and [Memory Digging Tips](/developer-docs/tips-and-tricks#memory-digging-tips).
**See also**: [Memory Inspector Overview](/developer-docs/memory-inspector)

To start or restart a test, click **Reset** near the top left.

Expand All @@ -72,8 +72,6 @@ Each time you perform 4 then 5, the number of possibilities or 'candidates' will

When you've found an address you're happy with, you can write a short note for what it is and hit **Save Note**, this will store it on database, and will be automatically restored next time you load up the memory viewer for this game, wherever you are! Note that after clicking 'Save Note', the note will be automatically stored on the database, and shared so all developers will share access to these memory notes. They will all be downloaded afresh when you load a ROM. If you try to overwrite a note, it will check with you first before submitting.

You can find more useful [Memory Digging Tips here](/developer-docs/tips-and-tricks#memory-digging-tips).

## Achievement Sets

So the memory location for the number of rings is stored at `0xfe20` - note to a non-programmer, we're dealing in [hexadecimal numeral system](https://simple.wikipedia.org/wiki/Hexadecimal_numeral_system) which can be daunting, but don't worry, essentially it's just numbers and letters instead of only numbers, and not forgetting `0x` at the start to show that it's a memory location in hex. We've found an address we're interested in and stored it using **Save Note**. We now want to create a new achievement.
Expand Down Expand Up @@ -116,7 +114,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#achievement-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.

## Testing the Achievement

Expand All @@ -138,9 +136,9 @@ Here are some tips you have to keep in mind when creating your achievements:

- **~~Never~~ Avoid making achievements with only one condition as much as you can**. Otherwise it will most likely pop at the wrong time. This is the **most common error by a developer**

- If the game has a **demo mode** (AI plays the game after you wait a while on the title screen), make sure to [find the address for it](/developer-docs/tips-and-tricks#finding-the-address-for-demo-mode) and add a condition so your achievements don't trigger in demo mode. You'll also need to know how to use [PauseIf](/orphaned/achievement-logic-features#pauseif) and [ResetIf](/orphaned/achievement-logic-features#resetif).
- If the game has a **demo mode** (AI plays the game after you wait a while on the title screen), make sure to find the address for it and add a condition so your achievements don't trigger in demo mode. You'll also need to know how to use [PauseIf](/developer-docs/flags/pauseif) and [ResetIf](/developer-docs/flags/resetif).

- **[PauseIf](/orphaned/achievement-logic-features#pauseif) cheat codes**: If the game has a cheat code to increase lives, select stages, etc., make sure to find the addresses for it and add some kind of protection in your achievements. OK, maybe it's not a very basic topic, but you have to keep it in mind when creating an official achievement set.
- **[PauseIf](/developer-docs/flags/pauseif) cheat codes**: If the game has a cheat code to increase lives, select stages, etc., make sure to find the addresses for it and add some kind of protection in your achievements. OK, maybe it's not a very basic topic, but you have to keep it in mind when creating an official achievement set.

- **Avoid creating achievements for just entering a stage.** As it can be earned by a password or a stage select cheat code. It is preferred to make achievements for finishing stages, [like in this template here](/developer-docs/achievement-templates#finish-level-n). Also, **do not create achievements for just starting a game or "starting a game with character X"**.

Expand All @@ -154,18 +152,14 @@ Here are some tips you have to keep in mind when creating your achievements:

- It can take a while to understand how the memory works in a game, so try spending as much time with it as you can, especially if it's your first attempt at developing achievements.

You can find more in the [Tips and Tricks page](/developer-docs/tips-and-tricks).

## Next Steps

Now that you know how to use the Memory Inspector, and the Achievement Editor. It's time to learn new techniques and practice:

- In order to refine your achievement logic, you can see what features you have in the [Achievement Logic Features](/orphaned/achievement-logic-features) page.
- In order to refine your achievement logic, you can see what features you have in the [Achievement Development Overview](//developer-docs/achievement-development-overview) page.

- Another way to learn is by looking at existing achievements that other devs made with an extra explanation in the [Real Examples](/developer-docs/real-examples) page.

- You can also see some generic examples in the [Achievement Templates](/developer-docs/achievement-templates) page.

- Once you have learned the basic techniques, you can continue your quest to become an achievement developer by following the steps explained here: [How to Become an Achievement Developer](/developer-docs/how-to-become-an-achievement-developer)

Have fun!
- Once you have learned the basic techniques, you can continue your quest to become an achievement developer by joing the [Junior Developer Program.]](/developer-docs/jr-dev-rules)
Loading