Document ~ and $ for leaderboards page

kdecks commented 5 years ago

~ will submit the largest value of multiple lookups.

example: 0x0f3336*~0xM0f3314$0x0f32d6*~0xM0f32b4$0x0f3306*~0xM0f32e4$0x0f3366*~0xM0f3344 for http://retroachievements.org/leaderboardinfo.php?i=2282

I thought that maybe I/we could use this as a to-do list of things that need documentation, maybe. That anyone could work on.

meleu commented 5 years ago

I thought that maybe I/we could use this as a to-do list of things that need documentation

what are you referring to with "this"? This very issue here (#9)? The issue tracker in general?

I have an issue to be used as a ToDo for the docs: #6. But, well, you know gemini people :gemini:... I moved to other stuff (RABot, RAWeb, etc).

Breaking those items into different issues sounds like a good idea :+1:

kdecks commented 5 years ago

“Don’t document the problem, fix it.”– Atli Björgvin Oddsson

bah

I mean taking note of something that should be added into the docs, as an issue. There's plenty of ways to improve the docs.

There that to-do list is. I'll make use of it.

Jamiras commented 5 years ago

~ actually inverts the bits of the value. $ will submit the largest value. The string you've provided as an example reads as:

select the maximum of:
* 16-bit 0x0f3336 if bit0 of 0x0f3314 is 0   (~ changes 0 to 1, or 1 to 0, so if bit is set, multiply by 0)
* 16-bit 0x0f32d6 if bit0 of 0x0f32b4 is 0
* 16-bit 0x0f3306 if bit0 of 0x0f32e4 is 0
* 16-bit 0x0f3366 if bit0 of 0x0f3344 is 0

The plaintext description is:

If p1 is cpu, ignore score for p1. If p2 is cpu, ignore score for p2. If p3 is cpu, ignore score for p3. If p4 is cpu, ignore score for p4. Select highest of remaining values.

Note that ~ only works for bits in the current dll/RetroArch. Full data type inversions will be supported by rcheevos in future releases.

RetroAchievements / docs-archive

Document ~ and $ for leaderboards page #9