televandalist / radocstemp Goto Github PK

When running the serve command with mkdocs, the current command creates the following error log:
log.txt

The markdown files in the "docs" subfolder should be all updated to match the case-sensitivity in the mkdocs.yml file.

Remove irrelevant terms, and find a better way to present it. Some form of table maybe with two columns "Term", "Definition". Right now, it's an eye-sore to read...

Lots of devs have their own repos/wikis. We should pool these together.

This page should start with an explanation on how achievement processing actually works. Could use the beginning of the "Getting Started" doc as a reference https://docs.retroachievements.org/Getting-Started-as-an-Achievement-Developer/

https://squidfunk.github.io/mkdocs-material/reference/admonitions/

There are many achievements that get away with what are typically unwelcome concepts. We should come up with a list of these and provide explanations for why they were allowed.

Docs need to reflect the following:

1. In cases where Demo or Prototype are used alongside Hack or Homebrew, they are to be listed after the latter. Example: Homebrew Demo Bob's Game instead of Demo Homebrew Bob's Game. My reason for this is that no matter what stage the game is in, it will always be a homebrew or a hack; therefore, those tags should take priority. (7v1)

2. In cases where a game is unlicensed and is actually just a hack of another game, then "Hack" would be used instead of "Unlicensed" - An example is Final Fantasy VII on NES, which is a bootleg/pirate release, but it's actually just a hack of Final Fantasy III that was put on a cartridge. So the RA entry would be Hack Final Fantasy VII. The only other one I can think of off the top of my head is Super Mario 4 on Game Boy, but I'm sure there are many more. I don't play that trash so I'm not 100% sure. (8v1)

3. When both English and Japanese titles are used in an RA entry's title, the Japanese title should only be first when the game was never officially released in English, making whatever English title used an unofficial title. The perfect example for this is probably Trials of Mana | Seiken Densetu 3, which is fine because an official English release came much later. Before that, everyone used Secret of Mana 2 as the English title, in which case the RA entry's title would have been Seiken Densetsu 3 | Secret of Mana 2. (8v1)

4. Since the A/An/The articles are moved to the back of a title (but BEFORE a subtitle), then we should also do this when there is a pipe separator between regional titles. For example, instead of Garfield Labyrinth | The Real Ghostbusters | Mickey Mouse IV, which is what it is currently, we use Garfield Labyrinth | Real Ghostbusters, The | Mickey Mouse IV. The reason for this is because we may eventually have a way to set which titles we view by default. (9v1)

5. While I think people mostly follow this, I would like it set in stone that bootleg/pirate games are not to be linked to hubs for the series they're ripping off. (6v1)

The fourth one DID NOT pass 😢
4. When including regional titles in an RA entry's title, versions of the game that are not actually linked to the set should not be included. (1v5)

I got this info from the PCSX2 server, which I think some of it should be noted in our docs.

We need an overview of the Bookmarks and Code Notes windows

I threw this together as a placeholder...

• Decide on the categories

• Figure out what's going to go where. For example: should something be in the "Developer" category or the "Create" category?

Using the PS2 subset patch instructions I just posted in Discord as an example:

Changing the hash:
- Open the .iso in a hex editor such as HxD.
- Search for "SYSTEM.CNF"
- Several lines above this will be a serial number. For example, "SLUS_202"
- Change the "SLUS" to "RAUS" or whatever else you want.
- Search "SLUS_202" or whatever the number in step 3 was.
- The next and last occurrence that needs to be changed should be after or on a line that says "BOOT2 = cdrom: \". 
- Change the "SLUS" to "RAUS" here as well.
- File -> Save as and name it something else.

Making the patch:
- Since most PS2 .iso files are a bit beyond what FLIPS can handle, we'll use xDelta.
- Open xDelta.
- Click the "Create Patch" tab.
- For Original File, select the unmodified .iso.
- For Modified File, select the new .iso you saved in HxD.
- For Patch Destination, save it wherever and type a filename. "Game Name [Subset - Type].xdelta" should do.
- Click "Patch"

Note: The .xDelta file created should only be a few KB in size. The bigger it is, the more likely it is that something went wrong. The one I made in this example was for Dot Hack Part 1 - Infection (USA) (En,Ja).iso and was only 10KB.

Another Note: If these steps don't work for you, let me know and I'll see if I can reproduce the issue and assist in making the patch. 

The majority of the pages were copy/pasted from docs.retroachievements.org so there are a lot of links that still direct to those docs. Need to fix all of those...

A lot of the current pages on here were from cloning the actual docs wiki back in February. There hasn't been a ton of updates, but I'd they be current.

I'm going to go through the GitHub log on Discord and update every page where wiki edits were logged this year.

Edit: I made the list. Going to go through the version histories and make the changes.

Should be as simple as copying the editor_theme-dark.json from here into the overlay folder and renaming it editor_theme.json.

See RetroAchievements/RALibretro#347

Going to need to rewrite a bunch of stuff to reflect recent changes.

Something like this:

Self-explanatory

The more I start working on this restructure for this section, I feel as if we should sort the sidebar for the two main pages as the ones marked in squares:

I don't know how we feel since this technically doesn't make the CoC "one page", but I figured it might be easier to then split it out by page topics rather than just one big giant cluster on a single markdown file. Using Developers as an example, we could have a collapsible structure such as:

---Developer Code of Conduct
|_____Revision Guidelines
|_____Unwelcome Concepts
|_____Achievement Set Checklist

I think that for future changes/removals in both CoCs it might be easier to navigate. Also another important point to consider if we add in two new subfolders under "guidelines" for "user" and "dev" to make the flow of markdown files easier to navigate.

Like this:

Use this https://retroachievements.org/achievement/254903 for an example of using Add Source with the * comparison. The addresses are simple 0->1 flags, but you get a specific amount of ore each time. The value in each of the Add Source conditions is equal to the amount of ore you get. This makes it so the achievement is actually tracking the total, which the game itself does not do.

Any of the Mission Mode achievements in Soulcalibur can be used as examples of using Add Source with the / comparison. Specifically, when you need at least one of each of something. An example: https://retroachievements.org/achievement/195883. The Add Source conditions use addresses that tell how many times a mission has been completed. Since we need each one to be completed at least once, we can use the / comparison to divide the address' values by themselves; therefore, they'll always be either 0 or 1.

Need to comb through the images on here and see what site images need to be updated. It looks a lot different as of a few days ago ;)

List and detail ways people can contribute to the docs even if they're not comfortable with GitHub.

A handful of examples would be to make use of the discussions section of the repo, open issues for things they thing need to be made more clear, reporting errors and obsolete info, and submitting images if the current ones are out-of-date or could be improved,

One thing we can always use more of are logic examples and tricks from devs.

We could also open an docs forum channel on the Discord.

Doc info needed for the following teams and function:

• DevQuest Team
• Writers
• DevCompliance
• QA Maintainers
• Compatibility Testing
• Play Testers
• Update Code Reviewers
• Update RAdmin (+ BombSquad?)

I liked voiceofautumns' post, could definitely use a spot in documentation