diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index 6ffa78e3..68e10501 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -280,7 +280,7 @@ function sidebarGuidelines(): DefaultTheme.SidebarItem[] { }, { text: "Refactoring Requirements", - link: "/guidelines/content/refactoring-requirements", + link: "/guidelines/content/refactor-requirements", }, ], }, diff --git a/docs/guidelines/content/refactor-requirements.md b/docs/guidelines/content/refactor-requirements.md index e2faa896..1276aa6b 100644 --- a/docs/guidelines/content/refactor-requirements.md +++ b/docs/guidelines/content/refactor-requirements.md @@ -28,8 +28,30 @@ The following aspects of a set must all be up to modern standards in order to be ## Code Notes -Code notes must, at a minimum, contain the address's size, a description of what the address does or why it is used in the achievement code, and enumerated values and their associated. -- Values must be in hexidecimal or float format, listed in increasing value by default +Refactored sets will follow a strict format standard that must be adhered to. Code notes must, at a minimum, contain the address's size, a description of what the address does or why it is used in the achievement code, and enumerated values and their associated definitions. + +**Static addresses** + +Static addresses shall be formatted as follows: + +- Bracketed size at the beginning of every note, may include BE or BCD as appropriate [16-bit BE], [16-bit BCD], [16-bit BE BCD] +- Bitflags shall not be bracketed, but may be included in the note description, not required though as seeing values as Bits makes it clear that the address contains bitflags +- Address description in clear, concise verbiage - may expand as needed, but should not unnecessarily +- Values listed either in hex or float depending on address type. Should be increasing in order unless out of order makes sense for something like Map ID progression where the IDs are not ordered sequentially +- Values must use an = sign, however spacing is optional: no spaces, space before/after =, or on both sides + +``` +[16-bit BE BCD] Description +0x0000=Value 1 +... +0x0001=Value 2 +``` +``` +[8-bit] Event bitflags +Bit0 = Something occurred +... +Bit7 = Something else occurred +``` ## Achievement Logic