Add links to documentation

This commit is contained in:
NGnius 2020-03-04 18:05:15 -05:00
parent fd98879ccd
commit c1bb863578
2 changed files with 10 additions and 5 deletions

View file

@ -3,12 +3,14 @@
Unofficial Gamecraft modding API for interfacing Gamecraft from mods. Unofficial Gamecraft modding API for interfacing Gamecraft from mods.
The GamecraftModdingAPI aims to simplify the mods in two ways: The GamecraftModdingAPI aims to simplify the mods in two ways:
- *Ease-of-Use* The API provides many easy methods to call to do common tasks such as moving blocks and adding commands. - *Ease-of-Use* The API provides convenient ways to do common tasks such as moving blocks and adding commands.
All of the Harmony patchings are done for you, so you can focus on writing your mod instead of reading swathes of undocumented code. All of the Harmony patching is done for you, so you can focus on writing your mod instead of reading swathes of undocumented code.
- *Stability* The API aims to be reliable and consistent between versions. - *Stability* The API aims to be reliable and consistent between versions.
This means your code won't break when the GamecraftModdingAPI or Gamecraft updates. This means your code won't break when the GamecraftModdingAPI or Gamecraft updates.
For more info & support, please join the ExMods Discord: https://discord.gg/xjnFxQV For more info, please check out the [official documentation](https://mod.exmods.org).
For more support, join the ExMods [Discord](https://discord.gg/xjnFxQV).
## Installation ## Installation
[Please follow the official mod installation guide](https://www.exmods.org/guides/install.html) [Please follow the official mod installation guide](https://www.exmods.org/guides/install.html)

View file

@ -7,15 +7,18 @@
<li class="footer" style="display:none;">$generatedby <li class="footer" style="display:none;">$generatedby
<a href="http://www.doxygen.org/index.html"> <a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li> <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
<li class="footer">Contact ExMods | <a href="https://discord.gg/xjnFxQV"><span>Discord</span></a> | <a href="https://twitter.com/NGniusness"><span>Twitter</span></a> | <a href="mailto:ngniusness@gmail.com"><span>Email</span></a> |</li>
</ul> </ul>
</div> </div>
<!--END GENERATE_TREEVIEW--> <!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW--> <!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small> <hr class="footer"/><address class="footer" style="display:none;"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html"> $generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/> <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion </a> $doxygenversion
</small></address> </small>
Contact ExMods | <a href="https://discord.gg/xjnFxQV"><span>Discord</span></a> | <a href="https://twitter.com/NGniusness"><span>Twitter</span></a> | <a href="mailto:ngniusness@gmail.com"><span>Email</span></a> |
</address>
<!--END !GENERATE_TREEVIEW--> <!--END !GENERATE_TREEVIEW-->
</body> </body>
</html> </html>