Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 3.73 KB

README.md

File metadata and controls

122 lines (87 loc) · 3.73 KB
Raw

Where's My Editor?

Where's My Editor? logo
Logo created by rubice!

Where's My Editor? is a level editor for the mobile game, Where's My Water? and all it's spinoffs.

NOTE: If you came here to read a .waltex image, then go to wmwpy. waltex.py has moved there.

Get started

To get started

  1. Get the latest release from the releases tab. Extract the zip folder into it's own folder (to keep it's files organized).
  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.
  3. Open the Where's My Editor app (wme.exe)
  4. Select the game folder.
  5. Now you got it up and running.

If you run into any issues, please send a bug report (shortcut in Help > Send bug report, or the issues page in this repository).

Development

If you're going to be editing wme, you should also edit wmwpy, as wmwpy handles all the reading and writing of the wmw files.

Setup

  1. Create a folder that both wme and wmwpy can be in.
/
  /wheres-my-editor
  /wmwpy
  1. Clone wme into wheres-my-editor
git clone https://github.com/wmw-modding/wheres-my-editor.git
  1. Clone wmwpy into wmwpy
git clone https://github.com/wmw-modding/wmwpy.git
  1. Create wme virtual environment

A virtual environment is a very good thing to use, because it allows you to keep an instance of all the installed modules without overriding your main installation.

cd wheres-my-editor
python -m venv .venv
./.venv/Scripts/activate
  1. Install dependencies
pip install -r requirements.txt
  1. Add local clone of wmwpy
pip install -e ../wmwpy

The -e argument is used to tell pip that you want wmwpy to be editable, aka, if you edit wmwpy from your clone, it will be updated in wme.

  1. Run wme

Now you can run wme

cd src
python main.py

Build exe

Install dependencies

To build an exe for wme, you need to install the dependencies.

pip install -r requirements-build.txt

This will override your editable installation of wmwpy (in the venv, it will not replace your edits), so you'll have to reinstall wmwpy again.

pip install -e ../wmwpy

You can also edit requirements.txt to replace wmwpy@git+https://github.com/wmw-modding/wmwpy with -e "../wmwpy", and then you won't have to bother with reinstalling wmwpy, but if you're going to be publishing your edits, you might want to replace it with the link to your wmwpy clone repo instead of a path to your local clone.

Note: you need requirements.txt in the same directory, as this requirements-build.txt references requirements.txt.

Build exe

python build.py

The output is in dis/wme.exe (it won't be an exe if you're not on windows).

Todo

  • Export xml file
  • Export png file
  • Add and remove objects
  • Room object.
    • This has kind of been implemented, because wmw1 uses the image for the room placement, but the later games use an object (which can be loaded).
  • Complete settings menu
  • Level explorer
  • Fix some objects not loading
  • Image editor

Credits

  • Thanks to rubice! for creating the logo. I am not skilled enough to make something that looks that good.
  • Thanks to campbellsonic for the script to load waltex images. I could not have done it without them.

Special thanks

  • Thanks to AwesomeDragon970#8068 for helping debug the program on MacOS. They are very awesome!