Skip to content

Commit

Permalink
Initial commit. Hello future!
Browse files Browse the repository at this point in the history
  • Loading branch information
Lunatrius committed Mar 29, 2015
0 parents commit 904c753
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
@@ -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
```
3 changes: 3 additions & 0 deletions README.md
@@ -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.

0 comments on commit 904c753

Please sign in to comment.