Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 904c753
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Prepare the config file | ||
In order to prevent any kind of confusion **only XML** configs are accepted. You can easily convert from the other formats to XML by using the in-game command `/igi save <filename>.xml`. | ||
|
||
*Note: even if your config file is already in the XML format you should still use the command before submission. That will ensure that the file is properly formatted.* | ||
|
||
## Config file name | ||
All submitted files should have the following filename structure: | ||
|
||
``` | ||
InGameInfo-<author>-<shortname>.xml | ||
InGameInfo-<author>-<shortname>.md | ||
InGameInfo-<author>-<shortname>-001.png | ||
InGameInfo-<author>-<shortname>-002.png | ||
InGameInfo-<author>-<shortname>-003.png | ||
... | ||
``` | ||
|
||
Where you should replace the `author` tag with your own name/nickname and `shortname` with something short that roughly describes your config file (`default_tweaked`, `compact`, `thaumcraft`, etc). | ||
|
||
# Description file | ||
Use the following template for your description file (`.md`): | ||
``` | ||
TODO: create template | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# InGame Info Configs | ||
This repository is a collection of community contributed configs for [InGame Info XML](https://github.com/Lunatrius/InGame-Info-XML). | ||
If you'd like to submit your own config file, please read the [guidelines for contributing](CONTRIBUTING.md) before opening a pull request. |