Skip to content
70 changes: 59 additions & 11 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,13 +1,61 @@
# SeedQueue

## Description
SeedQueue is a mod that is meant to replace multi-instancing. Instead of having multiple Minecrafts generating worlds open at the same time, it does it all in just one Minecraft instance as it has a built-in wall screen that can be configured through the SpeedrunAPI menu and further customized through resource packs. This greatly improves performance, especially for lower end hardware, and is also aimed to make speedrunning more accessible.
## Dependencies
To use [SeedQueue](https://github.com/KingContaria/seedqueue/releases/latest) you will also need Atum and SpeedrunAPI, you can get them from [here](https://mods.tildejustin.dev/).
## Latest Release
Get the latest release of SeedQueue from [here](https://github.com/KingContaria/seedqueue/releases/latest).
## Tutorial to get started with SeedQueue
If you are new and want to get started with SeedQueue watch this [tutorial](https://www.youtube.com/watch?v=fGu2MYZxh_c).
## SeedQueue Wiki
You can learn more about the config settings for SeedQueue and get guidance for customization of your Wall Screen on the [SeedQueue Wiki](https://github.com/KingContaria/seedqueue/wiki).
## Discord Server
If you are looking forward to getting in touch with the SeedQueue Community, join the SeedQueue discord server by clicking [here](https://discord.gg/9P6PJkHCdU).

SeedQueue is a mod for Minecraft Speedrunning that enables quick resetting of worlds by loading multiple worlds at one time. Designed to replace multi-instancing, SeedQueue is able to achieve this with only one instance of Minecraft.

### Key Features

- Built-in "Wall" screen
- Highly configurable with in game options and resource packs
- Improved performance, particularly on lower-end hardware
- Easy to setup

## Installation

> [!IMPORTANT]
> SeedQueue is only compatible with Fabric Loader version 16.0 and later.

### Prerequisites

1. **Fabric Installation:**
Ensure [Fabric](https://fabricmc.net/use/installer/) is installed. [Prism](https://prismlauncher.org/) and [MultiMC](https://multimc.org/) are easy tools for installing Fabric.
Comment thread
memerson12 marked this conversation as resolved.
Outdated

1. **Compatible Mods:**
SeedQueue only works with mods approved for speedrunning. You can find the list of compatible mods on the [MCSR Mod List](https://mods.tildejustin.dev/).

### Installation Steps

1. **Download SeedQueue:**
[Download the latest release](https://github.com/KingContaria/seedqueue/releases/latest) of SeedQueue

1. **Place in Mod Folder:**
Put the SeedQueue `.jar` file along with its dependencies in your `mods` folder

1. **Launch the Game:**
Happy resetting and good luck!

### Dependencies

All the mods listed below can be downloaded from the [MCSR Mod List](https://mods.tildejustin.dev/).
| Mod | Description | Required | Required for Wall Screen | Recommended |
| :----------------- | :----------------------------------------------------------------------------------------------------------------: | :----------------: | :----------------------: | :----------------: |
| Atum | Automatically reset RSG and SSG | ✅ | | ✅ |
| SpeedrunAPI | API for MCSR mods, providing a Config API, selected Fabric API modules and MixinExtras. | ✅ | | ✅ |
| WorldPreview | Makes you reset block game fast | | ✅ | ✅ |
| Sodium | Sodium is a free and open-source optimization mod for Minecraft which improves frame rates and reduces lag spikes. | | ✅ | ✅ |
| FastReset | Skips saving worlds to reset faster. | | ✅ | ✅ |
| AntiResourceReload | Disables the monitored reload upon world creation. | | | ✅ |
| Starlight | Rewrites the light engine to fix lighting performance and lighting errors | | | ✅ |

## Getting Started

If you're new to SeedQueue, watch this [tutorial video](https://www.youtube.com/watch?v=fGu2MYZxh_c) to get started.

## Documentation

For more information on configuration settings and customization options for the Wall Screen, visit the [SeedQueue Wiki](https://github.com/KingContaria/seedqueue/wiki).

## Community

Join the SeedQueue community on Discord by clicking [here](https://discord.gg/9P6PJkHCdU).