Skip to main content

A multiworld randomizer for Metroid Prime and Metroid Prime 2: Echoes.

Project description

Randovania

Welcome to Randovania, a randomizer platform for a multitude of games.

Supported Games

  • Metroid Prime
  • Metroid Prime 2: Echoes
  • Cave Story

Experimental Games

  • Metroid Prime 3: Corruption
  • Metroid Dread
  • Super Metroid

Here you will be able to randomize many aspects of either game, while still being ensured it's possible to finish without any trick or glitch! What can be randomized?

  • Randomize what can be found in each pickup location, including major upgrades, expansions, keys and artifacts.

  • Play with multiple people, via multiworld sessions. Your pickups will be shuffled among the games of everyone involved, no matter what game they're playing!

  • Randomize where each teleporter goes, or what you need to unlock a translator gate. In either case, there's advanced options for how they're shuffled.

  • The location you start the game in as well as the items you start with. If you're feeling brave, you can even shuffle items you normally start with, like the Power Beam and Scan Visor.

So have fun and start randomizing.

Installation

Windows

In the releases page, we have zip files with everything ready to use. Just extract and run!

Linux

Running (in-source)

  1. Clone this repository (downloading the source zip is not supported and will not work)

  2. Open a terminal in the repository root

  3. Fetch the tags from the repo:

    $ git fetch --tags

  4. Checkout the latest tag (replace v4.0.1 with the latest release version):

    $ git checkout v4.0.1

  5. Prepare the virtual environment and install dependencies:

    $ tools/prepare_virtual_env.sh

  6. Run the program from source:

    $ tools/start_client.sh

Running Natively and Multiworld

  1. Activate the virtual environment and generate the necessary configuration.json, as well as build a native application:

    $ . venv/bin/activate
    (venv) $ export PRODUCTION=true
    (venv) $ python tools/create_release.py
    
  2. Navigate into the build/randovania directory

  3. Install the generated randovania.pkg or run the generated executable

Community

Join the Randovania Discord: https://discord.gg/M23gCxj6fw

Invite links for specific games' servers can be found in the #game-communities channel in our server.

Credits

GUI and logic written by Henrique Gemignani, with contributions by SpaghettiToastBook, gollop and many others.

BashPrime, Pwootage, and April Wade made https://randomizer.metroidprime.run/, from which the GUI was based.

Games

Metroid Prime 1

Metroid Prime 2: Echoes

Metroid Prime 3: Corruption

Super Metroid

  • Game Patching and Logic Database by SolventMercury.
  • Custom Item PLMs patch by Kazuto.
  • Skip Intro Saves patch by PHOSPHOTiDYL.
  • Other individual patches by Total, Foosda, Leodox, and others.

Cave Story

Metroid Dread

  • Game Patching by Henrique Gemignani and duncathan_salt.
  • Room data initially collected by KirbymastaH (connections), Dyceron (area names) and Henrique Gemignani (initial structure).
  • Morph Ball and Speed Booster pickup textures created by BigSharkZ. Spider Magnet pickup texture by duncathan_salt with help from BigSharkZ.

Auto Tracker

  • Game theme assets were provided by MaskedTAS.
  • Pixel theme assets were provided by Shawn Sigma.

Multiworld

Server and logic written by Henrique, including Dolphin and Nintendont integrations. These were based on Dolphin Memory Engine and Pwootage's Nintendont fork, respectively. In-game message alert initially written by encounter.

Developer Help

Dependencies

Setup

Getting started:

  1. Clone this repository (downloading the zip is not supported and will not work)
  2. Open a terminal in the repository root
  3. Run the following file:
    1. Windows: tools/prepare_virtual_env.bat
    2. Linux/macOS: tools/prepare_virtual_env.sh
  4. You should see "Setup finished successfully." visible when the command finishes.

In order to start Randovania, open:

  1. Windows: tools/start_client.bat
  2. Linux/macOS: tools/start_client.sh

In order to update your repository:

  1. Update the git repository. (With git pull or anything else)
  2. Make sure that Randovania is closed.
  3. Re-run the steps from "Getting Started", starting at step 2.
    1. In case of unexpected errors, delete the venv in the root of the repository and start again.
  4. Open Randovania normally.

In order to run the tests:

  1. Run both "Getting started" and "Start Randovania" steps.
  2. Activate the virtual env. Check start_client.bat/sh for details.
  3. Run python -m pip install -r requirements.txt.
  4. Run python -m pytest test.

In order to run the server:

  1. Run both "Getting started" and "Start Randovania" steps.
  2. Activate the virtual env. Check start_client.bat/sh for details.
  3. Run python -m pip install -r requirements.txt.
  4. Run python tools/prepare_dev_server_config.py once.
  5. If you wish to use any Discord functionality, you'll need to create an app in Discord and fill both ids in tools/dev-server-configuration.json.
  6. Run the server with tools/start_dev_server.bat and the client with tools/start_debug_client.bat.

Suggested IDE: PyCharm Community

Documentation

Project details


Release history Release notifications | RSS feed

This version

4.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

randovania-4.3.0.tar.gz (14.2 MB view details)

Uploaded Source

Built Distribution

randovania-4.3.0-py3-none-any.whl (12.9 MB view details)

Uploaded Python 3

File details

Details for the file randovania-4.3.0.tar.gz.

File metadata

  • Download URL: randovania-4.3.0.tar.gz
  • Upload date:
  • Size: 14.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for randovania-4.3.0.tar.gz
Algorithm Hash digest
SHA256 4660593a88810983326cbabecc529b247aa54e95db01433412b0ff64be37901d
MD5 051dcd184475b7b2919712a9a1c45812
BLAKE2b-256 f41a207ed040953be5d7fa4e4eb3180579cc8709e1dc0630f81ddcb28d25ebaa

See more details on using hashes here.

File details

Details for the file randovania-4.3.0-py3-none-any.whl.

File metadata

  • Download URL: randovania-4.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for randovania-4.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a385ebf7e884e80f1334c549bd4e9ea58dda3e046febc3510c708614d8aab74
MD5 6a47d9c480d4a1be973cef333d0338c5
BLAKE2b-256 8ac8d7d3eebb8907e5e1b034f51bb0d809e41570c34b103f9f84b36823c6b6e0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page