docs: almost complete.

Author: Redbeanw44602

README.md

@@ -2,77 +2,17 @@
 
 This repository regenerates debug information (like PDB) from LeviLamina's public data.
 
-## Background
+## Usage
 
-- After 1.21.3.01, Mojang removed debug information from BDS.
-- Mojang no longer provides any debugging information (both server and client) to the community.
-- Mojang has an agreement with LiteLDev to provide them with debug data.
-- LiteLDev generates header files and obfuscated symbol to RVA lookup tables from debug data and provides them to the community.
+It's all [here](https://bedrockdebug.info/). (for PDB generation, see the **Tutorial**)
 
-### Problems caused by Mojang's collaboration with LiteLDev
-
-- Mojang's collaboration with LiteLDev is opaque and we have no idea what they do.
-- LiteLDev has completed its monopoly, and there will no longer be a second mod loader in the community.
-- Due to the obfuscated format, the community can no longer reverse engineer BDS.
-
-### Header files, obfuscation format and security
-
-- LeviLamina's design necessitates that they publish header files.
-- The header file contains all the declaration information so that symbols can be generated.
-- The RVA of the corresponding symbol can be extracted from the obfuscated format at runtime.
-- The obfuscated format is actually a carrier of the complete "symbol table", which used to be PDB/DWARF.
-
-## Tool for restoring original DebugInfo from obfuscated format
-
-> [!NOTE]
-> LiteLDev has not yet released bedrock_runtime_data/magicblob for the Linux server.
-
-They are dethunk, dumpsym, askrva and makepdb. Each tool is in a directory with the same name as it, and also has a README to help you use it.  
-In short, the PDB is generated by the following steps:
-
-- Preprocess the header files published by LiteLDev by dethunk.
-
-```
-python main.py {HEADER_PROJECT_DIR}/src
-```
-
-- Compile the header file and load the dumpsym plugin in the compilation parameters.
-
-```
-xmake f -c -p windows -a x64 -m release --sdk=/opt/msvc --cxflags="-fplugin=/path/to/libdumpsym.so -fplugin-arg-dumpsym-record-decl-name" --toolchain=clang
-xmake -v
-```
-
-- Find the generated symbols file.
-
-```
-{HEADER_PROJECT_DIR}/build/.objs/bdsheader/windows/x64/release/test/__cpp_main.cpp.cpp.symbols
-```
-
-- Generate symbol table using askrva.
-
-```
-./askrva __cpp_main.cpp.cpp.symbols --output succeed.json --output-failed failed.txt --output-format=makepdb
-```
-
-- Generate PDB using makepdb.
-
-```
-./makepdb --program bedrock_server.exe --symbol-data succeed.json --output bedrock_server.pdb
-```
-
-## TODO
-
-- [ ] Tap into more available symbols.
-- [ ] Fully open source HeaderGen.
-- [ ] Bootstrap.
-
-## Be with us
+## Community
 
 Our vision is to build an open and inclusive Minecraft: Bedrock Edition ecosystem.
 
-- [https://t.me/bdsplugins](https://t.me/s/bdsplugins)
+- [Discord](https://discord.gg/fPKVZScPT7)
+- [Telegram (Channel)](https://t.me/s/bdsplugins)
 
-## LICENSE
+## License
 
-All tools are open source under the MIT license.
+This project is open source under the MIT license.

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+---
+icon: octicons/code-of-conduct-16
+---
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

docs/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+---
+icon: octicons/repo-push-16
+---
+
+# Contributing Guide
+
+We welcome contributions of any kind, including but not limited to
+
+- Open a new issue and tell us what you think.
+- Contribute directly to the _DebugInfo_ toolchain.
+- Correct documentation errors, including translation errors.
+- Write a new tutorial.
+- Any others may not be listed.
+
+## Coding style
+
+- All code must be formatted before submission (follow `ruff.toml` and `.clang-format`)
+- Except for the class name which uses CamelCase, all others use snake_style.
+- Private member names begin with `m_` (C++ code only).
+
+## Interface Stability
+
+- Great, you don't need to make ABI stability guarantees!
+- Tool usage should not be significantly modified (as appropriate)

docs/ask-rva.md

@@ -0,0 +1,21 @@
+# Community
+
+<div class="grid cards" markdown>
+
+-   :fontawesome-brands-discord:{ .lg .middle } __Discord__
+
+    ---
+
+    The best place to communicate together.
+
+    [:octicons-arrow-right-24: Join the group](https://discord.gg/fPKVZScPT7)
+
+-   :fontawesome-brands-telegram:{ .lg .middle } __Telegram__
+
+    ---
+
+    If you just want to receive notifications.
+
+    [:octicons-arrow-right-24: Subscribe to channel](https://t.me/bdsplugins)
+
+</div>