Pitching in with Content - CityGenerator/Megacosm-Generator GitHub Wiki
One of the benefits of Megacosm Generator is that most of the data is pulled from fairly simple data files. Adding a new option is usually as simple as adding another line to a data file. In truth, there is only one rule.
All version of the sentence need to parse properly.
While there is only this one rule, it's surprisingly tricky to follow. Each addition needs to take into account the following:
- balancing tenses among all involved variables and text
- balancing in each sentence that uses it
- using the correct pronouns
- using proper plurals
- etc.
As long as the resulting sentences parse properly, it's usually good enough.
##Prerequisites## Before we get started, you'll need a github account. Fortunately these are totally free. Just click on that little green signup button in the corner and follow the prompts.
##Getting Started- Fork Me## If you haven't done so already:
- Log into your github account
- go to https://github.com/CityGenerator/Megacosm-Generator
- click the "Fork" button on the top righthand side
- Navigate to your newly created fork, probably something like https://github.com/USERNAME/Megacosm-Generator
##Simple Editing##
- On your fork, click on the data directory in the file listing.
- Click on cuisine.data
- click the edit button
- locate the "LPUSH cuisine_flavor" section and add a new flavor (remember to keep it alphabetical!)
- scroll to the bottom of the page and enter a comment describing the change, then hit commit
Submit a Pull Request##
Once you have made your change, you can let me know by:
- clicking the pull request icon on the right sidebar (the second one down)
- click the new pull request button
- click the "Click to create a pull request for this comparison" text at the top
- add a title and message, then click "send pull request"
It's really that simple!
Updating Your Fork##
Unfortunately there is no simple way to refresh your fork; your best bet is to merge in the upstream develop branch. Fortunately, this is simply a pull request to yourself.
- Go to your main fork page, https://github.com/USERNAME/Megacosm-Generator
- click the pull requests on the righthand sidebar
- click the new pull request button
- click the edit button
- change the base fork to your develop branch
- click "compare across forks" if it's available
- change the head fork to Megacosm Generator's develop branch
- click "Click to create a pull request for this comparison" text at the top
- add a title and message (to yourself), then click "send pull request"
- click the green "merge pull request"
- click the green "confirm" button
And with any luck, everything should "just work".
Let me know if you run into any issues. -Morgajel