-
Notifications
You must be signed in to change notification settings - Fork 26
Create More In-Depth README #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
memerson12
wants to merge
16
commits into
contariaa:main
Choose a base branch
from
memerson12:update-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+104
−11
Draft
Changes from 7 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
0b5c20d
first update
memerson12 a123f3c
update dependencies
memerson12 d23db78
Merge branch 'KingContaria:main' into update-readme
memerson12 8b1a1db
update install instructions
memerson12 5ca17ea
add spacing in list
memerson12 81e6558
Change checkmarks
memerson12 b04d20b
updated description
memerson12 2a760b5
reorder multimc and prism
memerson12 3db26ad
Merge branch 'KingContaria:main' into update-readme
memerson12 a32186d
add faq
memerson12 95f564d
spelling + punctuation
memerson12 e42ff8b
upload video
memerson12 5469d2a
move video
memerson12 4170ccc
move video
memerson12 f5620da
Update README.MD
memerson12 4a9f0bf
remove video in repo
memerson12 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
| 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). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.