Ixrec
220248dd3d
Docs: define and explain the trade-off of "local" vs "remote" items ( #5718 )
...
* first draft
* second draft
* fix indentation of bullet point wrapped lines
* move quote
* explicitly discuss all three item handling flags, since the start inventory one is easily forgotten
* rewrite to avoid a 'debate between two camps' framing
* tweak the wording to allow for the possibility that some games can 'just' do both local and remote items without exposing this detail to the player
* relative links
2026-01-20 20:15:00 +01:00
Ixrec
5932160f15
Docs: add dev FAQ for 'should I start with the APWorld or the client?' ( #5716 )
...
* Docs: add dev FAQ for 'should I start with the APWorld or the client?'
* fix indentation of bullet point wrapped lines
* use %20 for spaces in links
* link to adding games.md and add #ap-modding-help to adding games.md
* make APQuest a link
* also linkify 'run a local server'
* reword the 'judging client is easier' point to reflect a broader range of first-timers
* move the 'not 100%' point into the introductory sentences, and tweak related wording
* correct link
2026-01-20 20:14:43 +01:00
Ixrec
72854cde44
Docs: Add a "Missable Locations" Question to apworld FAQ ( #4965 )
...
* Docs: add a "missable locations" question to apworld_dev_faq.md
Basically turning the conversation at https://discord.com/channels/731205301247803413/1214608557077700720/1368996789260128388 into a FAQ entry.
* feedback
* qwint feedback
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
---------
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2025-05-14 07:21:40 -04:00
Ixrec
dffde64079
Docs: add a "soft logic" question to apworld_dev_faq.md ( #4953 )
...
* add a "soft logic" question to apworld_dev_faq.md
* Update apworld_dev_faq.md
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* add a reminder about progression and how it influences soft logic implementations
---------
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2025-05-07 12:20:21 -04:00
qwint
0ba9ee0695
Docs: update line length in apworld faq doc ( #4960 )
2025-05-07 10:47:14 -04:00
Scipio Wright
c40214e20f
Docs: Minor Changes to apworld_dev_faq.md ( #4947 )
...
Co-authored-by: qwint <qwint.42@gmail.com >
2025-05-07 10:41:37 -04:00
qwint
78c93d7e39
Docs: Add FAQ section for corrupted metadata debugging ( #4705 )
...
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2025-04-10 13:00:48 -04:00
qwint
1ca8d3e4a8
Docs: add description of Indirect Condition problem ( #4295 )
...
* Docs: Dev FAQ - About indirect conditions
I wrote up a big effortpost about indirect conditions for nex on the [DS3 3.0 PR](https://github.com/ArchipelagoMW/Archipelago/pull/3128#discussion_r1693843193 ).
The version I'm [PRing to the world API document](https://github.com/ArchipelagoMW/Archipelago/pull/3552 ) is very brief and unnuanced, because I'd rather people use too many indirect conditions than too few.
But that might leave some devs wanting to know more.
I think that comment on nex's DS3 PR is probably the best detailed explanation for indirect conditions that exists currently.
So I think it's good if it exists somewhere. And the FAQ doc seems like the best place right now, because I don't want to write an entirely new doc at the moment.
* Actually copy in the text
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: qwint <qwint.42@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: qwint <qwint.42@gmail.com >
* Update apworld_dev_faq.md
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update apworld_dev_faq.md
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update apworld_dev_faq.md
* Update docs/apworld_dev_faq.md
Co-authored-by: qwint <qwint.42@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: qwint <qwint.42@gmail.com >
* fix the last couple of wording issues I have with the indirect condition section to apworld dev faq doc
* I didn't like that wording
* Apply suggestions from code review
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Apply suggestions from code review
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
* Update docs/apworld_dev_faq.md
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
---------
Co-authored-by: NewSoupVi <57900059+NewSoupVi@users.noreply.github.com >
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2024-12-12 21:24:38 +01:00
Exempt-Medic
b6e5223aa2
Docs: Expanding on the answers in the FAQ ( #3690 )
...
* Expand on some existing answers
* Oops
* Sphere "one"
* Removing while
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
---------
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2024-07-25 23:02:25 +02:00
qwint
79843803cf
Docs: Add header to FAQ doc referencing other relevant docs ( #3692 )
...
* Add header to FAQ doc referencing other relevant docs
* Update docs/apworld_dev_faq.md
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
* Update docs/apworld_dev_faq.md
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
---------
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com >
Co-authored-by: Scipio Wright <scipiowright@gmail.com >
2024-07-25 23:01:22 +02:00
qwint
deae524e9b
Docs: add a living faq document for sharing dev solutions ( #3156 )
...
* adding one faq :)
* adding another faq that links to the relevant file
* add lined line breaks between questions and lower the heading size of the question so sub-divisions can be added later
* missed some newlines
* updating best practice filler method
* add note about get_filler_item_name()
* updates to wording from review
* add section to CODEOWNERS for maintainers of this doc
* use underscores to reference the file easier in CODEOWNERS
* update link to be direct and filter to function name
2024-07-25 09:05:04 +02:00
