Update readme.md #43

SmokeyDope · 2023-09-05T21:38:09+02:00

SmokeyDope commented

2023-09-05 21:38:09 +02:00

Fleshes out and cleans up the readme.md file for mineclone2-plus.
Add myself to credits, add links to licenses, clarify cc-by-sa is 4.0, update description of modpack.

Fleshes out and cleans up the readme.md file for mineclone2-plus. Add myself to credits, add links to licenses, clarify cc-by-sa is 4.0, update description of modpack.

SmokeyDope added 4 commits 2023-09-05 21:38:10 +02:00

90756cbf84 Update readme.md

46f061f4c0 Update README.md

4742b83f79 Update README.md

6e98f570dd Update README.md

SmokeyDope added 1 commit 2023-09-05 21:46:29 +02:00

0351fdde1f Update README.md

MrRar commented

2023-09-05 21:58:30 +02:00

The warning that the mod pack will irrevocably modify worlds needs to be more specific. I have no idea what's in this mod pack but if all it does is add some nodes and items no warning is warranted. On the other hand, if this mod pack changes the map gen or something it needs to say so.

SmokeyDope commented

2023-09-05 22:25:37 +02:00

@MyRar I agree and believe that the warning is redundant and it will be okay to remove it. I assume the warning was put there in the first way as just a liability/idiot-proofing thing. The extra structures mod is included but its a standalone thing that doesnt affect base game mapgen AFAIK.

Thanks for taking the time to look over this!

@MyRar I agree and believe that the warning is redundant and it will be okay to remove it. I assume the warning was put there in the first way as just a liability/idiot-proofing thing. The extra structures mod is included but its a standalone thing that doesnt affect base game mapgen AFAIK. Thanks for taking the time to look over this!

👍 1

SmokeyDope added 1 commit 2023-09-06 04:06:15 +02:00

869001af1a Update README.md

kneekoo commented

2023-09-06 15:50:49 +02:00

First-time contributor

I think a simple warning is worth having because people new to modding (and who read) would learn about "unknown node/item".

It could be as generic as this:

General advice

Using nodes and items from mods in a world means that the world will always need those mods for proper functionality. If you disable the mods at a later time, you will see "unknown node" or "unknown item". Everything else would still work as expected. Re-enabling the mods will make the nodes and items usable again.

This is probably something for Minetest to say on the mods page, so people don't get surprised with the unknown, but that would require a UI change.

I think a simple warning is worth having because people new to modding (and who read) would learn about "unknown node/item". It could be as generic as this: > ### General advice > Using nodes and items from mods in a world means that the world will always need those mods for proper functionality. If you disable the mods at a later time, you will see "unknown node" or "unknown item". Everything else would still work as expected. Re-enabling the mods will make the nodes and items usable again. This is probably something for Minetest to say on the mods page, so people don't get surprised with the *unknown*, but that would require a UI change.

👍 1 👎 1

SmokeyDope commented

2023-09-06 17:36:43 +02:00

@kneekoo Thats fine with me, I can add it in. I will wait a bit though to see what others think.

👍 1

SmokeyDope commented

2023-09-10 20:38:25 +02:00

@ancientmarinerdev Im not sure what to do here, was hoping more people would chime in for a defintive consensus but that doesn't seem to be the case. The split on people who think warning is a good idea vs those who don't are pretty close. Thoughts?

ancientmarinerdev commented

2023-09-10 22:40:18 +02:00

@ancientmarinerdev Im not sure what to do here, was hoping more people would chime in for a defintive consensus but that doesn't seem to be the case. The split on people who think warning is a good idea vs those who don't are pretty close. Thoughts?

I agree with what Nicu said. I think the warning is helpful.

> @ancientmarinerdev Im not sure what to do here, was hoping more people would chime in for a defintive consensus but that doesn't seem to be the case. The split on people who think warning is a good idea vs those who don't are pretty close. Thoughts? I agree with what Nicu said. I think the warning is helpful.

Michieal commented

2023-09-25 01:01:00 +02:00

The warning that the mod pack will irrevocably modify worlds needs to be more specific. I have no idea what's in this mod pack but if all it does is add some nodes and items no warning is warranted. On the other hand, if this mod pack changes the map gen or something it needs to say so.

I could be wrong, but I think that the extra_structures mod might hook into the mapgen, to place said structures. But, it should be self contained.

I know that the mods contained within, do add more nodes. Though, I will say that the basic user is not going to read it, as long as it works. I mean, I didn't check the readmes of Mineclone until I encountered a game ending bug... so... I kinda have to assume that others won't. I guess there are more conscientious people out there that do read everything before using it, and maybe I am just lazy. lol

> The warning that the mod pack will irrevocably modify worlds needs to be more specific. I have no idea what's in this mod pack but if all it does is add some nodes and items no warning is warranted. On the other hand, if this mod pack changes the map gen or something it needs to say so. I could be wrong, but I think that the extra_structures mod might hook into the mapgen, to place said structures. But, it should be self contained. I know that the mods contained within, do add more nodes. Though, I will say that the basic user is not going to read it, as long as it works. I mean, I didn't check the readmes of Mineclone until I encountered a game ending bug... so... I kinda have to assume that others won't. I guess there are more conscientious people out there that do read everything before using it, and maybe I am just lazy. lol

Michieal commented

2023-10-18 03:55:26 +02:00

@MrRar I agree and believe that the warning is redundant and it will be okay to remove it. I assume the warning was put there in the first way as just a liability/idiot-proofing thing. The extra structures mod is included but its a standalone thing that doesnt affect base game mapgen AFAIK.

Thanks for taking the time to look over this!

"This modpack may make changes to your worlds, that you may not be able to revert back to a standard Mineclone 2 world. Noted possibilities would be unknown items and unknown nodes, if you remove the pack." -- This was my writing. I put it in there because when people turn off mods / modpacks, they get unknown nodes / items, and then freak out and ask how to remove them. Also, I wanted to include things like LushCaves, which would affect mapgen. Hence the warning.
Currently, nothing (aside from the extra_structures mod) even touches the mapgen portion. And, I think that the way that Extra-Structures work, that it wouldn't affect the generation of new areas if it is removed.

So, the warning is probably heavy-handed, but... that's the explanation as to why it's in there.

> @MrRar I agree and believe that the warning is redundant and it will be okay to remove it. I assume the warning was put there in the first way as just a liability/idiot-proofing thing. The extra structures mod is included but its a standalone thing that doesnt affect base game mapgen AFAIK. > > Thanks for taking the time to look over this! "`This modpack may make changes to your worlds, that you may not be able to revert back to a standard Mineclone 2 world. Noted possibilities would be unknown items and unknown nodes, if you remove the pack.`" -- This was my writing. I put it in there because when people turn off mods / modpacks, they get unknown nodes / items, and then freak out and ask how to remove them. Also, I wanted to include things like LushCaves, which would affect mapgen. Hence the warning. Currently, nothing (aside from the `extra_structures` mod) even touches the mapgen portion. And, I think that the way that Extra-Structures work, that it wouldn't affect the generation of new areas if it is removed. So, the warning is probably heavy-handed, but... that's the explanation as to why it's in there.

Michieal commented

2023-10-18 03:57:18 +02:00

@SmokeyDope I would like for the "Creators" section to remain, please. Obviously, have a contributors section and by all means, have your name in there! 😃

But, the history of this package... yeah - it needs the creators section.

@SmokeyDope I would like for the "Creators" section to remain, please. Obviously, have a contributors section and by all means, have your name in there! 😃 But, the history of this package... yeah - it needs the creators section.

SmokeyDope closed this pull request

2024-01-05 19:20:03 +01:00