diff --git a/README.md b/README.md index 24880e7..c8bdbc7 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,40 @@ Supports Windows 7, 8, 8.1, 10, 11. Go to the Ballance root folder and delete `BMLPlus.dll` in the `BuildingBlocks` directory. If you would like to remove the entire data of BML (installed mods, maps, configs, etc.), delete the `ModLoader` folder as well. -## Troubleshooting +## Frequently Asked Questions (FAQ) -If your game crashes after installing BML+, or you encounter bugs while playing with BML+, please raise a new Issue on GitHub with the following information: +### Q1: How can I confirm if BML+ is installed correctly? -- Describe the condition you met in detail. -- Provide screenshots to help explain if possible. -- Paste the content of `ModLoader.log` (found in the `ModLoader` folder). +After launching the game, you should see the BML message at the top of the game UI. If you do not see this message, please check if the files are correctly placed in the root directory of the game and original BML or older version of BML+ is removed. + +### Q2: What should I do if BML+ is not loaded? + +If BML+ is not loaded, try the following steps: + +- Ensure that `BMLPlus.dll` is correctly placed in the `BuildingBlocks` directory. +- Check if there are any conflicting files from previous versions of BML or other mods. +- Make sure you have the [Visual C++ Redistributable for Visual Studio 2015-2022](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) installed on your system. +- If the problem persists, open an issue on GitHub. + +### Q3: What should I do if my game crashes after installing BML? + +Ensure that you followed the installation instructions correctly. If the problem persists, please open an issue on GitHub and provide the following information: + +- A detailed description of the problem you encountered. +- Screenshots to help explain the issue, if possible. +- The content of the `ModLoader.log` file (found in the `ModLoader` directory). + +### Q4: How do I update to a new version of BML+? + +Download the latest version and replace the old files according to the installation steps. + +### Q5: Is BML+ compatible with mods for the original BML (mods with extension .bmod)? + +No, BML+ is not compatible with mods created for the original BML that have the `.bmod` extension. + +### Q6: Is BML+ compatible with the original player? + +No, BML+ is built for the [New Player](https://github.com/doyaGu/BallancePlayer) and cannot support the original player properly. ## License