Skip to content

WoWs-Builder-Team/minimap_renderer

Repository files navigation

Minimap Renderer

Tests

Minimap Renderer parses World of Warships replays to create a timelapse video that resembles the in-game minimap.

enter image description here

Try it on in Google Colab

Installation

  1. Install Python 3.10
  2. Create a Python virtual environment and activate it.
    • Linux
       python3.10 -m venv venv && . venv/bin/activate
      
    • Windows
       py -3.10 -m venv venv && venv\Scripts\activate.bat
      
    • You should now see (venv) at the start of the command prompt.
  3. Install the renderer package. To install the renderer package use this command.
    pip install --upgrade --force-reinstall git+https://github.com/WoWs-Builder-Team/minimap_renderer.git
    
  4. You're all set.

Usage

Replays can be rendered with render module. The full usage is:

python -m render --replay <replay_path>

This will create a .mp4 file from your replay file.

Since the renderer is installed to a virtual environment, you need to activate it once before you render. Once activated, you can render any replay file as long as it is a valid replay file.

License

This project is licensed under the GNU AGPLv3 License.

Credits and Links

JetBrains Logo (Main) logo.

  • This project is supported by Jetbrains through their Open Source Support program.

  • This project is maintained by @notyourfather#7816 and @Trackpad#1234.

  • However, it would not have been possible without Monstrofil's replays_unpack!

  • A minimal Discord bot wrapper is available here.

  • One with additional features is available here.