TinyLifeWeb/README.md

13 lines
1.4 KiB
Markdown
Raw Normal View History

2021-12-01 10:55:45 +01:00
![The Tiny Life banner](https://raw.githubusercontent.com/Ellpeck/TinyLifeWeb/main/docs/media/banner.png)
2021-08-20 13:41:37 +02:00
Welcome to the Tiny Life Modding API! On [the site](https://docs.tinylifegame.com), you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.
2021-08-20 13:41:37 +02:00
# What next?
- To install a mod, custom lot or custom household, check out the [custom content installation](https://docs.tinylifegame.com/articles/getting.html) tutorial.
- To create your first mod, check out the [modding basics](https://docs.tinylifegame.com/articles/mod_basics.html) tutorial or the [example mod](https://github.com/Ellpeck/TinyLifeExampleMod).
- This site features a web version of the modding API's [documentation](https://docs.tinylifegame.com/api/TinyLife.html) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
2021-08-20 13:41:37 +02:00
# Contributing
2021-12-01 10:55:45 +01:00
If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls). If you found an error in the game's API documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).
2021-08-20 13:41:37 +02:00
Thank you for supporting Tiny Life's custom content community!