Skip to main content

A randomizer platform for a multitude of games.

Project description

Randovania

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

New here or looking to install? Check our website. It also contains the list of supported games.

Randovania can randomize many aspects of its supported games, all while still ensuring they're completable without using any glitches or exploits. Its features include:

  • Randomizing what can be found in each item location. Weapons, keys, and more can end up in completely new places.

  • Use Multiworld sessions to shuffle items between multiple separate games, alone or with friends. All Multiworld games are compatible with each other - mix and match as you like!

  • Randomize how areas connect to one another, or what resources are required to travel between areas. These options are highly customizable, letting you limit or unleash the chaos.

  • Randomize your starting equipment and location. Feeling brave? You can even shuffle items you normally start with.

Have fun and start randomizing!

Installation

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

For Linux users, we recommend using our Flatpak instead.

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 and duncathan_salt. portfolYOU Jekyll theme by Youssef Raafat. Free for personal and commercial use under the MIT license.

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

Linux Flatpak build contributed by Ethan Lee.

Games

Metroid Prime

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.

Cave Story

Metroid Dread

Another Metroid 2 Remake

Metroid: Samus Returns

Auto Tracker

Primes

AM2R

Metroid: Samus Returns

  • Game theme assets were provided by Dyceron.

Multiworld

Server and logic written by Henrique "Darkszero" Gemignani.

Primes

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

Cave Story

Cave Story Doukutsu and CSE2 Tweaked integations written by duncathan_salt, periwinkle and ikuyo.

Metroid Dread

Integration written by Thanatos and Henrique "Darkszero" Gemignani. The "unplug" icon is by tezar tantular from Noun Project (licensed under CC BY 3.0).

Another Metroid 2 Remake

Integration written by Miepee. Offworld sprites are licensed under CC BY-SA 4.0 and are made by AbyssalCreature, ShirtyScarab554 and many others.

Metroid: Samus Returns

Integration written by Thanatos.

Developer Help

Dependencies

  • Git
  • UV
    • This is installed automatically during step 3 of Getting started.

Setup

Getting started:

  1. Clone this repository. If you want to clone your fork, make sure that during the forking process you uncheck the Copy main branch only checkbox. Because the git history is needed, 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 --thin
    2. Linux/macOS: tools/prepare_virtual_env.sh --thin
  4. You should see "Setup finished successfully." visible when the command finishes.
  5. For certain use cases, such as exporting games or running tests, replace --thin with --full.

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 be able to export games:

  1. Run the "Getting started" step with --full instead of --thin.
  2. Start Randovania normally.

In order to run the tests:

  1. Run the "Getting started" step with --full instead of --thin.
  2. Run uv run pytest.

In order to run the server:

  1. Run the "Getting started" step.
  2. Run uv run tools/prepare_dev_server_config.py once.
  3. 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.
  4. Run the server and client. You can this on
    1. Windows with tools/start_dev_server.bat for the server and tools/start_debug_client.bat for the client
    2. Linux/macOS with tools/start_dev_server.sh for the server and tools_start_debug_client.sh for client

This repository uses pre-commit. The hook is automatically configured with the prepare_virtual_env scripts.

Suggested IDE: PyCharm Community

Visual Studio Code

Clone this repository and open the folder in Visual Studio Code. It suggests several useful plugins for developing which you should download and install.

If your Python is setup properly, you can use the Create venv with all exporters task by pressing CTRL+SHIFT+P, type in Task, select Tasks: Run task and then select the task. It will create the venv with all the dependencies installed for you.

Then make sure that the Python extension is installed and select the Python installation from the venv via CTRL+SHIFT+P and Select Python: Interpreter.

There is also a task defined to run all tests. To run individual tests you can utilise the Testing section of Visual Studio Code. You can simply run or debug a test there.

To start Randovania you can press CTRL+F5. If you only press F5, Randovania will start with a debugger. Be aware that starting with a debugger makes the application much slower.

UV Commands

Updating a single package:

uv lock --upgrade-package my-dependency

Installing your patcher as editable:

uv pip install -e ..\factorio-randovania-mod\

Documentation

Project details


Release history Release notifications | RSS feed

This version

9.2.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-9.2.0.tar.gz (24.2 MB view details)

Uploaded Source

Built Distribution

randovania-9.2.0-py3-none-any.whl (22.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: randovania-9.2.0.tar.gz
  • Upload date:
  • Size: 24.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for randovania-9.2.0.tar.gz
Algorithm Hash digest
SHA256 a740a39899e88713b6407cc3b9fa3e0b6f08c86bae44e19fac49f3b335b48ad8
MD5 02021671c2be58b0cec0d39439d8791c
BLAKE2b-256 0864f6b4249a707aad9a50d00b76a73cfbd9061e43d630e7bc692792984c9f0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: randovania-9.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for randovania-9.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 deb14b2caf18db3d9cf20c8c92f9cf314bb6eb8e78e3659d356b483e5d1cd405
MD5 b11ce22fa74ce4090df7a3da69b1f88f
BLAKE2b-256 89404f5847dcdc149a04170ecaf95b450854a42dd9abebf6e78c299e9f3fc402

See more details on using hashes here.

Supported by

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