Ellpeck/TinyLifeExampleMod
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeExampleMod.git synced 2024-05-17 22:58:45 +02:00
Code Issues Projects Releases Wiki Activity

put API docs in repo

Browse source
This commit is contained in:
Ell 2021-02-02 09:16:46 +01:00
parent 5d0ec63187
commit ec070db217
2 changed files with 15100 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15099
ApiDocumentation.md Normal file
View file

File diff suppressed because it is too large Load diff

2
README.md
View file

@ -20,7 +20,7 @@ dotnet nuget add source https://nuget.ellpeck.de/v3/index.json --name "Ellpeck"
This repository also contains a little script called `Run.sh` that you can use to automatically build your mod, copy it into the `Mods` directory of your Tiny Life instance and run the game. Just be sure to modify all of the paths first.
The game's API is **fully documented**. The documentation is easily accessible by opening any of the API's files in your IDE. There's also a CTRL-F-able version available [on the wiki](https://github.com/Ellpeck/TinyLifeExampleMod/wiki/API-Documentation).
The game's API is **fully documented**. The documentation is easily accessible by opening any of the API's files in your IDE. There's also a CTRL-F-able version available [here](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/ApiDocumentation.md).
## Distributing mods
To distribute your mod to other people, all you have to do is go into the `bin/Debug/netcoreapp3.0` folder after building and copy your mod's `dll` and the `Content` directory. You can either send them to your friends directly or pack them into an archive first.