Create More In-Depth README

[memerson12]

Create a more in-depth readme per issue #25

[contariaa]

Under dependencies it would probably be good to mention that WorldPreview, Sodium and FastReset are required to use the Wall Screen and that mods like AntiResourceReload and Starlight are highly recommended because performance without them is quite bad.
You could also include a compatibility warning that says SeedQueue only supports other mods allowed for speedrunning.

[Crystal15118]

Under dependencies it would probably be good to mention that WorldPreview, Sodium and FastReset are required to use the Wall Screen and that mods like AntiResourceReload and Starlight are highly recommended because performance without them is quite bad. You could also include a compatibility warning that says SeedQueue only supports other mods allowed for speedrunning.

Adding the Warning before the Description should be fine right? or do you have a specific place in mind

[Crystal15118]

@KingContaria i added a bit more information on dependencies in this commit as you said and also added a compatibility warning, any further suggestions?

[memerson12]

Which format do you all like more, the list format or table format

List Format:

Dependencies

Warning

SpeedQueue is only compatible with other mods approved for speedrunning. Check the MCSR Mod List for a list of approved mods.

The following mods are required to run SeedQueue:

• Atum
• SpeedrunAPI

The following mods are required to be able to use the Wall Screen:

• WorldPreview
• Sodium
• FastReset

The following mods are recommended for best performance:

• AntiResourceReload
• Starlight

---

Table Format:

Dependencies

Warning

SpeedQueue is only compatible with other mods approved for speedrunning. Check the MCSR Mod List for a list of approved mods.

Mod	Required	Required for Wall Screen	Recommended
Atum	✔️
SpeedrunAPI	✔️
WorldPreview		✔️
Sodium		✔️
FastReset		✔️
AntiResourceReload			✔️
Starlight			✔️

[maskersss]

imo table looks better, though all mods should be Recommended

[contariaa]

I like the table it looks good, i agree with maskers

[memerson12]

Updated it. Just as a note, if you want to look at a preview of the readme without the git changes, you can see it on my fork

[Crystal15118]

Which format do you all like more, the list format or table format

List Format:

Dependencies

Warning

SpeedQueue is only compatible with other mods approved for speedrunning. Check the MCSR Mod List for a list of approved mods.

The following mods are required to run SeedQueue:

• Atum
• SpeedrunAPI

The following mods are required to be able to use the Wall Screen:

• WorldPreview
• Sodium
• FastReset

The following mods are recommended for best performance:

• AntiResourceReload
• Starlight

Table Format:

Dependencies

Warning

SpeedQueue is only compatible with other mods approved for speedrunning. Check the MCSR Mod List for a list of approved mods.

Mod Required Required for Wall Screen Recommended
Atum ✔️
SpeedrunAPI ✔️
WorldPreview ✔️
Sodium ✔️
FastReset ✔️
AntiResourceReload ✔️
Starlight ✔️

i like table format more
edit: just noticed the other comments

[contariaa]

I would still like an updated README, although this PR is quite outdated at this point (for example regarding ports) and I would like some changes:

• FAQ should probably be part of the wiki rather than the readme
• link to an up to date and complete setup tutorial (either by osh or by draconix, osh's is outdated in a couple points but still mostly fine)
  If there is interest in picking this PR back up that would be fantastic, otherwise I might take inspiration to make my own version.