Skip to content
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

[Aftershock] Design Doc Draft #46666

Merged

Conversation

Maleclypse
Copy link
Member

@Maleclypse Maleclypse commented Jan 10, 2021

Summary

SUMMARY: Mods "Aftershock Design Doc"

Purpose of change

Update design doc to reference the ongoing total conversion mod direction that Aftershock is taking.

Describe the solution

Updates Readme.MD. First draft. Putting some words to paper. Open to suggestions. @Mom-Bun

Describe alternatives you've considered

None

Testing

N/A

Additional context

@Maleclypse Maleclypse marked this pull request as draft January 10, 2021 23:05
@Maleclypse Maleclypse added [Markdown] Markdown issues and PRs Mods: Aftershock Anything to do with the Aftershock mod labels Jan 10, 2021
Copy link
Contributor

@actual-nh actual-nh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting! I am looking forward to further developments (and helping with a few).

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 10, 2021

Let me take a look at this, but one thing that stands out to me is the "here be dragons" section

Do we need this? It just identifies where files go, and a quick "git grep" or asking maintainers could figure out where everything goes I think?

@Maleclypse
Copy link
Member Author

Let me take a look at this, but one thing that stands out to me is the "here be dragons" section

Do we need this? It just identifies where files go, and a quick "git grep" or asking maintainers could figure out where everything goes I think?

That's a question you can ask, it will cause me to ask questions about your parentage and how you are exceptionally polite for someone raised by wolves, who doesn't believe in Table of Contents. I am a firm believer in tables of contents and that as a mod grows in size they become even more important as eventually we may need to use those ToC spaces to explain design choices and request additional content from contributors. :)

@actual-nh
Copy link
Contributor

Let me take a look at this, but one thing that stands out to me is the "here be dragons" section

Do we need this? It just identifies where files go, and a quick "git grep" or asking maintainers could figure out where everything goes I think?

It is also a bit out of date - item groups are under, well, itemgroups, not under maps.

Copy link
Contributor

@Mom-Bun Mom-Bun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good for the first draft!
I'll be keeping an eye on this, and if anything stands out I'll make sure to note a review of it!

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 11, 2021

Let me take a look at this, but one thing that stands out to me is the "here be dragons" section
Do we need this? It just identifies where files go, and a quick "git grep" or asking maintainers could figure out where everything goes I think?

That's a question you can ask, it will cause me to ask questions about your parentage and how you are exceptionally polite for someone raised by wolves, who doesn't believe in Table of Contents. I am a firm believer in tables of contents and that as a mod grows in size they become even more important as eventually we may need to use those ToC spaces to explain design choices and request additional content from contributors. :)

Hahaha completely fair, I was mostly asking as there wasn't a table of contents in regular dda, or any other mod from what I know, so I was curious, but that makes sense considering how big this mod will end up being; so I'm alright with keeping it.

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 11, 2021

Oh another important thing, have you included something specifying how aftershock isn't a dumping mod?

@Maleclypse
Copy link
Member Author

Oh another important thing, have you included something specifying how aftershock isn't a dumping mod?

I haven't for a couple of reasons.

  1. I'm not super concerned about it, because the more truly different style content we add the more obvious it becomes that anyone saying that doesn't have a clue what they are talking about. I get that we haven't deployed the insanely different stuff like biomes yet.
  2. Because I'm not super worried I can't think of any phrasing that doesn't feel like we are "protesting too much".
  3. I'm strangely more concerned that I'll be more frustrated if I spend time writing "this is not a dump mod" when people inevitably ask questions about "aftershock the dump mod".

Anyway I'm totes fine with someone else writing up some kind of dump mod disavowal bur I'm not gonna worry about it in this PR.

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 11, 2021

Oh another important thing, have you included something specifying how aftershock isn't a dumping mod?

I haven't for a couple of reasons.

  1. I'm not super concerned about it, because the more truly different style content we add the more obvious it becomes that anyone saying that doesn't have a clue what they are talking about. I get that we haven't deployed the insanely different stuff like biomes yet.
  2. Because I'm not super worried I can't think of any phrasing that doesn't feel like we are "protesting too much".
  3. I'm strangely more concerned that I'll be more frustrated if I spend time writing "this is not a dump mod" when people inevitably ask questions about "aftershock the dump mod".

Anyway I'm totes fine with someone else writing up some kind of dump mod disavowal bur I'm not gonna worry about it in this PR.

Ah those reasons make sense, yeah!

Alright, this draft looks good by me then, as it mentions everything important so far :)

@kevingranade
Copy link
Member

Just FYI, once this is where you want it, we could put it on cataclysmdda.org for higher visibility.

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 12, 2021

Just FYI, once this is where you want it, we could put it on cataclysmdda.org for higher visibility.

Just to note, if the other maintainers don't object to it of course, I would love to have it on the site yea.

@Maleclypse Maleclypse changed the title [ WIP] [Aftershock] Design Doc Draft [Aftershock] Design Doc Draft Jan 13, 2021
@Maleclypse Maleclypse marked this pull request as ready for review January 13, 2021 03:55
@KorGgenT KorGgenT merged commit 6dd0a5d into CleverRaven:master Jan 28, 2021
@NoahGoldFox
Copy link
Contributor

Will there eventually be a version of aftershock that includes just more sci-fi stuff without the full conversion? for people who do want sci-fi but not a whole conversion.

@Mom-Bun
Copy link
Contributor

Mom-Bun commented Jan 29, 2021

Will there eventually be a version of aftershock that includes just more sci-fi stuff without the full conversion? for people who do want sci-fi but not a whole conversion.

In-repo, no.

You can always copy and paste the sci-fi stuff yourself and put it into a mod without the conversion stuff however.

@Maleclypse Maleclypse deleted the Aftershock-Design-Doc-and-modinfo-Update branch February 11, 2021 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Markdown] Markdown issues and PRs Mods: Aftershock Anything to do with the Aftershock mod
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants