ASolidSnack’s RA Guide Template (Intermediate‐Level Use) - RetroAchievements/guides GitHub Wiki

Template Introduction

  • This template uses markdown tables and some basic HTML in order to create a somewhat full RAguide. So if you haven't heard of any of that before, you might have a harder time using this template.
  • The template posted here may be out-of-date. I sometimes keep adding or changing stuff to my template and upload changes to my GitHub - RetroAchievements Repository, so refer there if you want the most up-to-date version.

Template Examples In-action

In order to use the template, I'd advise copy-pasting the markdown code from my GitHub - ASolidSnack’s RA Guide Template

THE GUIDE TEMPLATE STARTS HERE

Retro Achievements Guide
🔶 GAME_TITLE_HERE (PLATFORM_HERE)

_GAME_TITLE_HERE_ - Key Art


This guide provides comprehensive details on how to unlock each achievement within the base set, offering clear steps and strategies to ensure your success. Additionally, it includes useful information on the leaderboards for those interested in tracking their progress and competing at higher levels.

This guide mirrors the one available on the achievement set developer's Github

📑 Table of Contents

💎 Achievement Guide

_GAME_TITLE_HERE_ - RetroAchievements Mastery Icon
Set consists of xxxx achievements worth xxx points

Set released on DD MMMM YYYY

📜 SOME_GENERAL_INFO_HEADER

SOME_GENERAL_INFO_SUB_HEADER

SOME_GENERAL_INFO_HERE

📜 Walkthroughs & Resources

If the explanation here doesn't suffice feel free to search up some guides, here are a few helpful resources:

Essential Info & Tips

  • info_and_tip

  • info_and_tip

Important

important_info


🏆 Progression (_COUNT_ achievements - _XX_ points)

The achievements under this category revolve around ...

Warning

Warning_info

Progression Achievement List

Title (dev_id) Guidance & Insights

title_placeholder


a_placeholderID

Achievement badge icon
GENERAL_EXPLANATION_HERE

Fail Conditions

- fail_condition_info
If any fail condition is met, the player can easily retry the achievement by ...

Achievement Tracking

- A Trigger Indicator is displayed when ...
- A Measured Indicator tracks ... up to ...

Misc note ⁃ MISC_NOTE_HERE
Developer note ⁃ DEVELOPER_NOTE_HERE

🔗 Back to Table of Contents

🔗 Back to Top of Achievement Category


🏆 Challenges (_COUNT_ achievements - _XX_ points)

GENERAL_INFO_ABOUT_ACHIEVEMENT_CATEGORY

GENERAL_INFO_ABOUT_ACHIEVEMENT_CATEGORY

  • GENERAL_INFO_ABOUT_ACHIEVEMENT_CATEGORY
  • GENERAL_INFO_ABOUT_ACHIEVEMENT_CATEGORY

Additional Notes

  • ADDITIONAL_NOTES

  • ADDITIONAL_NOTES

SubTitle: ADDITIONAL_NOTES

Challenge Achievements Grouped by DifficultyMode

Click here to toggle open this summary
Difficulty Achievements Required Chapter + (achievement_link)
Easy (ACHIEVEMENT_COUNT) - achievement_title_placeholder Chapter "xxxx" ⇒ (a_placeholderID)
- achievement_title_placeholder any Chapter ⇒ (a_placeholderID)
- achievement_title_placeholder Chapter "xxxx" ⇒ (a_placeholderID)
Hard (ACHIEVEMENT_COUNT) - achievement_title_placeholder Chapter "xxxx" ⇒ (a_placeholderID)
- achievement_title_placeholder any Chapter ⇒ (a_placeholderID)
- achievement_title_placeholder Chapter "xxxx" ⇒ (a_placeholderID)

Challenge Achievement List

Title (dev_id) Guidance & Insights

title_placeholder


a_placeholderID

Achievement badge icon
GENERAL_EXPLANATION_HERE

Fail Conditions

- fail_condition_info
If any fail condition is met, the player can easily retry the achievement by ...

Achievement Tracking

- A Trigger Indicator is displayed when ...
- A Measured Indicator tracks ... up to ...

Misc note ⁃ MISC_NOTE_HERE
Developer note ⁃ DEVELOPER_NOTE_HERE
🔗 Back to Table of Contents

🔗 Back to Top of Achievement Category


🏆 Unlocks (_COUNT_ achievements - _XX_ points)

GENERAL_INFO_ABOUT_ACHIEVEMENT_CATEGORY

Note

NOTE_INFO

Additional Notes

  • ADDITIONAL_NOTES

  • ADDITIONAL_NOTES

Sub_Title: ADDITIONAL_NOTES

Unlock Achievement List

Title (dev_id) Guidance & Insights

title_placeholder


a_placeholderID

Achievement badge icon
GENERAL_EXPLANATION_HERE

Fail Conditions

- fail_condition_info
If any fail condition is met, the player can easily retry the achievement by ...

Achievement Tracking

- A Trigger Indicator is displayed when ...
- A Measured Indicator tracks ... up to ...

Misc note ⁃ MISC_NOTE_HERE
Developer note ⁃ DEVELOPER_NOTE_HERE

🔗 Back to Table of Contents

🔗 Back to Top of Achievement Category


🏆 Misc_AchievementCategory (_COUNT_ achievements - _XX_ points)

General_info_about_achievement_category

Note

Note_info

Additional Notes

  • additional_notes

  • additional_notes

Sub_Title: additional_notes

Misc_AchievementCategory Achievement List

Title (dev_id) Guidance & Insights

title_placeholder


a_placeholderID

Achievement badge icon
GENERAL_EXPLANATION_HERE

Fail Conditions

- fail_condition_info
If any fail condition is met, the player can easily retry the achievement by ...

Achievement Tracking

- A Trigger Indicator is displayed when ...
- A Measured Indicator tracks ... up to ...

Misc note ⁃ MISC_NOTE_HERE
Developer note ⁃ DEVELOPER_NOTE_HERE

🔗 Back to Table of Contents

🔗 Back to Top of Achievement Category


🥇 Leaderboard Guide

This section provides a detailed breakdown of the various leaderboards featured in the game, helping players understand how to compete, measure progress, and achieve high scores. Each leaderboard is thoroughly explained, covering its purpose, requirements, and how scores are calculated.

Inside, you’ll find:

  • Leaderboard Overviews: A description of what each leaderboard represents, such as chapter completion challenges or special gameplay modes.
  • Start Requirements: Information on how to activate the leaderboard, including prerequisites like starting conditions and restrictions on cheats.
  • Cancel Conditions: Clear explanations of what actions or circumstances will deactivate or invalidate the player's leaderboard attempt.
  • Submit Conditions: The steps necessary to successfully submit your score to the leaderboard.
  • Score Calculation Details: A breakdown of how the player's score is determined, with formulas and factors like accuracy, damage taken, time spent, and other gameplay metrics.

With this guide, the player will not only understand the mechanics behind each leaderboard but also gain insights into how to optimize performance and climb the ranks. Whether aiming to perfect a story chapter on higher difficulties or striving for the top spot in specific challenges, this section equips you with everything you need to know.

Leaderboard List

Title (dev_id) Guidance & Insights

title_placeholder


lb_placeholderID

SOME_GENERAL_INFO

Start Requirements

- INFO_ABOUT_START_REQUIREMENTS

Cancel Conditions

- INFO_ABOUT_CANCEL_CONDITIONS

Submit Conditions

- INFO_ABOUT_SUBMIT_CONDITIONS

Measured Value

- INFO_ABOUT_MEASUREDVALUE

Developer note ⁃ NOTE_HERE

🔗 Back to Table of Contents

🔗 Back to Top of Leaderboard Guide


📜 Credits

RA-User Role
RA-User Avatar Image 🟉 Achievement Set Developer | Badge Design | RA-Guide Author

RA-User Avatar Image 🟉 Contributor | Tester

- Contributed by ...
- Tested the ...

✏️ Footnotes

• Measured Indicator

An indicator displayed by the Retro Achievements overlay, often used to track specific progress within an achievement.

Examples:

  • Headshots - 7/12
  • Enemies left - 11/100
  • Accuracy - 47%
  • Coins collected - 88%

• Triggered Indicator

An indicator displayed by the Retro Achievements overlay, typically used to show when a challenge achievement is available for unlocking or when it is currently active. If this indicator disappears before the achievement unlocks, it often signals a failure, indicating that a retry is necessary.

Examples:

  • Enough headshots acquired, finish the mission
  • All enemies killed, kill the boss
  • Player has not yet taken a hit - for a hitless achievement
  • All requirements are met, continue the game to unlock...

⚠️ **GitHub.com Fallback** ⚠️