Skip to content

Latest commit

 

History

History
217 lines (152 loc) · 8.8 KB

README.md

File metadata and controls

217 lines (152 loc) · 8.8 KB
Raw

Randovania

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

New here or looking to install? Check our website.

Supported Games

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

Experimental Games

  • Metroid Prime 3: Corruption
  • 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.

Website created by Hugoshido.

Installer is powered by Advanced Installer, which has graciously provided us with an open source license.

Games

Metroid Prime 1

Metroid Prime 2: Echoes

  • Game patching written by Claris.
  • Room data initially collected by Claris, revamped by Dyceron.
  • Menu Mod created by Claris. For more information, see the Menu Mod README.
  • Converting Metroid Prime models by Migs.

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

Auto Tracker

  • Game theme assets were provided by MaskedTAS.

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