diff --git a/README.md b/README.md new file mode 100644 index 00000000..3bda61e6 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +## Goals + +* Identify all classes + * Create new static classes by grouping related members +* Identify all methods +* Identify all fields +* Identify all local variables +* Remove any remaining obfuscation (possibly none left) +* Fix poor decompiler behavior (fernflower) +* Replace magic numbers and bitmasks with named final fields +* Refactor code to improve behavior/readability +* Modernize code/libraries (High DPI support, modern refresh rates, ...) +* Support existing servers via global config flags that adjust packet behaviors + +OpenRS2 annotations are left in the source to build a deob map from, in case some of my changes aren't desirable. +That mapping can be used to generate a new deob with everything renamed for you.