Repository navigation
docs: add configuration, compatibility and contributing docs; slim the README - #20
Merged
Merged
Conversation
…e README docs/configuration.md lists every cfg key and command-line option, written from Options.cpp and d2dx-defaults.cfg. docs/compatibility.md has the per-version table derived from BuiltinResMod.cpp and D2DXContext.cpp, with what has actually been tested. CONTRIBUTING.md covers building, testing and the PR conventions for people. The README now links to them. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Replace the personal thanks with plain credits, merge SGD2FreeRes into the third-party list, and rename the 'It's ugly/slow/buggy' heading. Every third-party attribution is kept. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
jackrayner
force-pushed
the
docs/readme-phase2
branch
from
October 24, 2026 15:04
c5c752e to
7b95c5e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Second part of making the README the fork's own. Stacked on #19.
docs/configuration.md: every config key and command-line option, written fromOptions.cppandd2dx-defaults.cfgrather than the upstream wiki. I checked the order claim in the code (config file first, command line after) and whatdumptextureswrites.docs/compatibility.md: per-version table for custom resolutions and motion prediction, derived fromBuiltinResMod.cppandD2DXContext.cpp, with a "tested with this fork" column (only 1.14d, under Wine/Proton), plus Windows/Wine and mod notes.CONTRIBUTING.md: build, test and PR conventions for people;AGENTS.mdpoints to it.d2dx.zip.Worth a second look: the Wine/Proton
nocompatmodefixexplanation and the 1.14d result come from a report of one play session, not from anything I ran. Docs only, so the Windows job is skipped.🤖 Generated with Claude Code