From 64e7c09236bc1566c4d47d556c020c945ff2902e Mon Sep 17 00:00:00 2001 From: crosire Date: Mon, 3 Feb 2020 20:10:14 +0100 Subject: [PATCH] Add file overview to readme --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2f105ec..c27bb8c 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,27 @@ d3d8to9 [![Build Status](https://ci.appveyor.com/api/projects/status/aqupdda60ixgenyd?svg=true)](https://ci.appveyor.com/project/crosire/d3d8to9) -This is a pseudo-driver module that intends to improve compatibility and stability in games using Direct3D 8 for rendering by converting all API calls and lowlevel shaders to equivalent Direct3D 9 ones. By that it also opens those games to the new possibilities from proven tools and wrappers written for Direct3D 9. +This is a pseudo-driver module that intends to improve compatibility and stability in games using Direct3D 8 for rendering by converting all API calls and low-level shaders to equivalent Direct3D 9 ones. By that it also opens those games to new possibilities from proven modding tools written for Direct3D 9, including [ReShade](http://reshade.me). -## Contributing +## Building -You'll need Visual Studio 2013 or higher to open the project file. It is recommended to install the old standalone DirectX end-user runtime, which is required for the D3DX libraries used for disassembling and assembling the shaders. +You'll need Visual Studio 2013 or higher to build d3d8to9. It is recommended to install the old standalone DirectX end-user runtime, which is required for the D3DX libraries used for disassembling and assembling the shaders. -Any contributions to the project are welcomed, it's recommended to use GitHub [pull requests](https://help.github.com/articles/using-pull-requests/). +A quick overview of what some of the source code files contain: + +|File |Description | +|----------------------------------------------------------|---------------------------------------------------------------------------------| +|[d3d8to9.cpp](source/d3d8to9.cpp) | Definition of the main D3D8 entry point `Direct3DCreate8` | +|[d3d8to9_base.cpp](source/d3d8to9_base.cpp) | Implementation of the `IDirect3D8` interface, including device creation | +|[d3d8to9_device.cpp](source/d3d8to9_device.cpp) | Implementation of the `IDirect3DDevice8` interface, including shader conversion | +|[d3d8types.hpp](source/d3d8types.hpp) | Declaration of all used D3D8 types one would otherwise find in d3d8.h | +|[lookup_table.hpp](source/lookup_table.hpp) | Table to map D3D9 interface addresses to their matching D3D8 implementations | -## [Contributors](https://github.com/crosire/d3d8to9/graphs/contributors) +## Contributing + +Any contributions to the project are welcomed, it's recommended to use GitHub [pull requests](https://help.github.com/articles/using-pull-requests/). -Thank you to all the contributors making this project possible, especially [elishacloud](https://github.com/elishacloud) for the continuously excellent work improving compatibility with all sorts of games. +A big shout-out to all the existing [contributors](https://github.com/crosire/d3d8to9/graphs/contributors) who worked on improving compatibility, especially [elishacloud](https://github.com/elishacloud)! ## License