search

KingContaria / seedqueue

Minecraft mod that generates multiple worlds concurrently and lets players reset them on an ingame wall screen.
MIT License
32 stars 18 forks source link

Create More In-Depth README #35

Open memerson12 opened 3 months ago

memerson12 commented 3 months ago

Create a more in-depth readme per issue #25

KingContaria commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

@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 commented 3 months ago

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:

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

The following mods are recommended for best performance:

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 :heavy_check_mark:
SpeedrunAPI :heavy_check_mark:
WorldPreview :heavy_check_mark:
Sodium :heavy_check_mark:
FastReset :heavy_check_mark:
AntiResourceReload :heavy_check_mark:
Starlight :heavy_check_mark:
maskersss commented 3 months ago

imo table looks better, though all mods should be Recommended

KingContaria commented 3 months ago

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

memerson12 commented 3 months ago

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 commented 3 months ago

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