Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting document detailing several issues people can encounter while building the project. #17

Merged
merged 5 commits into from Apr 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions Readme.md
Expand Up @@ -19,9 +19,13 @@ Then,

For either of those to work, Game Assets has to be built.

Look at [the troubleshooting document](docs/Troubleshooting.md), it includes several common issues and how to fix them.

## Dependencies

On your build environment, for scripts to work, you need to install these
On your build environment, for scripts to work, you need to install these.

**NOTE**: You will need to use the Python 2 pip.

```
pip install git+https://github.com/desertkun/hjson-py
Expand Down Expand Up @@ -92,4 +96,4 @@ please join the Dev Support telegram channel below and ask for invite link.
If you have development question, please join
[Dev Support](https://t.me/+f8ha1XpCJS1mZmUy) group on Telegram.

Otherwise, feel free to join the [Official Discord Community Server](https://discord.gg/eeqyjeG7P5)
Otherwise, feel free to join the [Official Discord Community Server](https://discord.gg/eeqyjeG7P5)
Binary file added docs/ModuleError.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ResolveModuleError.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/Troubleshooting.md
@@ -0,0 +1,34 @@
## Run configurations not available

1. Close project
2. Delete `.idea`
3. Run `./gradlew idea` in root folder
4. Open project using `brainout.ipr` file

## Class not found in module

![](ModuleError.png)

1. Set `brainout.[modulename]` to `brainout.[modulename].main`
2. Repeat with each run configuration.
3. Click `Apply`

## "…dxRuntimeException: Error reading file: mainmenu…"
Make sure you have run the create data script successfully.
Check if all dependencies are installed correctly.

| Platform | Script |
|----------|-----------------|
| Windows | `make_data.bat` |
| Linux | `make_data.sh` |
| MacOS | `make_data.sh` |

## Python Issues
You will need to use Python 2 and the Python 2 version of pip.

## `make_data.py` TypeError
1. Make sure hjson is installed
```shell
pip install git+https://github.com/desertkun/hjson-py
```
2. Make sure that the desurtkun's fork is used instead of the default package if you have that installed already.