Skip to content

Commit 61a6a3d

Browse files
Update README.md
1 parent 06abf54 commit 61a6a3d

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
# Where's My Editor?
22
<p align="center">
3-
<img alt="Where's My Editor? logo" src="src/assets/images/WME_logo.png" width="50%" >
4-
<br>
5-
Logo created by rubice!
3+
<img alt="Where's My Editor? logo" src="src/assets/images/WME_logo.png" width="50%" >
4+
<br>
5+
Logo created by rubice!
66
</p>
7-
Where's My Editor? is a level editor for the mobile game, Where's My Water? and all it's spinoffs.
8-
9-
NOTE: If you came here to read a .waltex image, then go to [wmwpy](https://github.com/wmw-modding/wmwpy/blob/main/src/wmwpy/utils/waltex.py). `waltex.py` has moved there.
7+
Where's My Editor? is a level editor for the mobile game, Where's My Water? and all it's spinoffs.
108

11-
# Setup
9+
NOTE: If you came here to read a .waltex image, then go to [wmwpy](https://github.com/wmw-modding/wmwpy/blob/main/src/wmwpy/utils/waltex.py). `waltex.py` has moved there.
10+
11+
# Get started
12+
To get started
13+
1. Get the latest release from the [releases tab](https://github.com/wmw-modding/wheres-my-editor/releases/latest). Extract the zip folder into it's own folder (to keep it's files organized).
14+
2. Next, you need to get the game files. You can get them in many ways, but generally, you want to have the game extracted into a folder, and all the assets in the assets (or Content) folder.
15+
3. Open the Where's My Editor app (wme.exe)
16+
4. Select the game folder.
17+
5. Now you got it up and running.
18+
19+
If you run into any issues, please send a bug report (shortcut in Help > Send bug report, or the issues page in this repository).
20+
21+
# Building
22+
## Setup
1223

1324
run
1425
```
@@ -31,8 +42,8 @@ Once I make a full release, I will also make a wmwpy release, so this is only ne
3142

3243
Start by extracting your where's my water apk file into a directory. When you run the program for the first timze, it'll ask you to select the game directory. This can also be configurable in the `settings.json` file that is generated by the program.
3344

34-
# Build exe
35-
## Install modules
45+
## Build exe
46+
### Install modules
3647
To build an exe for wme, first install pyinstaller
3748

3849
```sh
@@ -51,7 +62,7 @@ Make sure `wmwpy` is installed from github (you shouldn't need to do this, as `w
5162
pip install wmwpy@git+https://github.com/wmw-modding/wmwpy
5263
```
5364

54-
## Build exe
65+
### Build exe
5566

5667
```sh
5768
py build.py

0 commit comments

Comments
 (0)