The official Burning Knight wiki data
First, create yourself a Github account and verify the Email address.
- Grab the id of the item you want to add. Therefore visit the item's wiki page and take the small text under the items name, starting with bk: - this is the item's id.
-
Open this link https://github.com/RexcellentGames/BkWikiData/tree/master/data/items
-
See if the item you want to add already has a description file in that folder. If it has, scroll down a bit and see the Editing an item's description section below. Please note that the semicolon in the id gets switched out for a _ here. So bk:itemname becomes bk_itemname.
-
Click on "Create new file"
- Name it bk_itemidhere.md - Example: An item with the id bk:itemname needs it's file to be this name:
- Add the description. That's pretty straight forward.
Tip: You can also preview your changes to get a rough idea of how they will look in the wiki. Click on "Preview" in order to do that.
- When you're done, scroll down a bit. Under "Propose new file", change the first text field to "Add description for [your item id here]". You can leave the second one empty.
-
Click on the bold green button.
-
Then, don't change anything and just continue by clicking on "Create pull request".
- Again, change nothing and click "Create pull request" one last time.
Your suggestion is now submitted and if it is good enough, one of the wiki admins will publish your changes on the official Burning Knight Wiki.
- Find the item's description file. If you don't know how to find the item id, please read the chapter above. Once you found the file, click it!
- Then click on the little pencil icon here:
- You can now edit the file like in the first chapter and submit your changes with the big green button.
Go ask us over at our Discord server! discord.gg/rexcellent
Egor Dorichev (@egordorichev)
Andreas May (@maanex)
Badosz (@badosz0)
smashyz
+ you! Just open a PR with your additions!