Modding:Overview: Difference between revisions

Jump to navigation Jump to search
2,830 bytes added ,  23:07, 25 September 2023
m
Add gnarf's Rhinoconaut mod and illuminatiswag's Terrors of the Depths mod
(Moves to Modding Resources category)
m (Add gnarf's Rhinoconaut mod and illuminatiswag's Terrors of the Depths mod)
 
(6 intermediate revisions by 3 users not shown)
Line 22: Line 22:
* If you plan to mod in your own tiles, familiarize yourself with a pixel editor, such as [https://www.piskelapp.com/ Piskel] (all major platforms and web).
* If you plan to mod in your own tiles, familiarize yourself with a pixel editor, such as [https://www.piskelapp.com/ Piskel] (all major platforms and web).
** GIMP is essentially useable, but it isn't designed specifically for pixel art and may take more work to make game tiles with it than with a dedicated pixel editor.
** GIMP is essentially useable, but it isn't designed specifically for pixel art and may take more work to make game tiles with it than with a dedicated pixel editor.
== Tutorials ==
If you're just getting started with modding, check out [[Modding:Tutorial - Snapjaw Mages]]. This tutorial is an end-to-end walkthrough of creating a new creature and some items, and then having them appear in-game. It also provides an introduction on browsing the game's data files, which you can then use to go on and mod in your own objects.
The [https://steamcommunity.com/sharedfiles/filedetails/?id=1302696701%7C Blue Ctesiphus tutorial] is also an excellent starting point for new modders.


== Possible Issues ==
== Possible Issues ==
Line 27: Line 33:
'''I'm stuck and don't know what to do.''' Feel free to ask for help or guidance in #modding on [https://discordapp.com/invite/cavesofqud the official Caves of Qud discord server]! There are several modders there who use the channel to talk through and ask for feedback on their mods.
'''I'm stuck and don't know what to do.''' Feel free to ask for help or guidance in #modding on [https://discordapp.com/invite/cavesofqud the official Caves of Qud discord server]! There are several modders there who use the channel to talk through and ask for feedback on their mods.


'''Where can I find <code>Player.log</code>?''' See [[file locations#Log file|file locations]].
'''How do I troubleshoot my mod?''' A good place to start is by reading the following files that are updated every time the game runs:
* <code>build_log.txt</code>: Includes compiler errors if your mod code has errors that will not compile. These errors can prevent your mod from being loaded at all.
* <code>Player.log</code>: Includes XML errors and other miscellaneous errors that can prevent your mod from working as intended, even if it does load. Search the file for <code>MODERROR</code> statements, and review carefully for other output lines that mention your mod.
 
'''Where can I find <code>build_log.txt</code> and <code>Player.log</code>?''' See [[file locations#Log file|file locations]].


'''My mod has been marked incompatible on Steam Workshop. What do I do?''' Update your mod to work with the latest stable or beta release of the game, then request that your mod be unmarked incompatible via either [https://discordapp.com/invite/cavesofqud the official Caves of Qud Discord server]'s #modding channel, or the support email address, [mailto:support@freeholdgames.com support@freeholdgames.com].
'''My mod has been marked incompatible on Steam Workshop. What do I do?''' Update your mod to work with the latest stable or beta release of the game, then request that your mod be unmarked incompatible via either [https://discordapp.com/invite/cavesofqud the official Caves of Qud Discord server]'s #modding channel, or the support email address, [mailto:support@freeholdgames.com support@freeholdgames.com].
Line 33: Line 43:
'''I keep getting an error when trying to save my game.''' Most likely, you have a list in your mod. Qud's default method of saving doesn't handle lists, so you need to handle it yourself. To see how, check out [[Modding: Serialization (Saving/Loading)|this article]] on how to override Qud's default saving/loading.
'''I keep getting an error when trying to save my game.''' Most likely, you have a list in your mod. Qud's default method of saving doesn't handle lists, so you need to handle it yourself. To see how, check out [[Modding: Serialization (Saving/Loading)|this article]] on how to override Qud's default saving/loading.
[[Category:Guides]]
[[Category:Guides]]
== Examples ==
The sources for many mods are available online under various free/libre licenses. These can be a good resource for getting started with creating your own mods.
The following is an (incomplete) list of sources for different mods:
{| class="wikitable" style="min-width: 50%;"
! Repository
! Corresponding mod(s)
! Concepts used
|-
| [https://bitbucket.org/gnarf37/qud-rhinoconaut/src/master/ gnarf37/qud-rhinoconaut]
| [https://steamcommunity.com/sharedfiles/filedetails/?id=2839943576 Rhinoconaut]
| Custom Preset, Custom player tile
|-
| [https://github.com/DeSevilla/my-qud-mods/tree/main/monsters DeSevilla/my-qud-mods/monsters]
| [https://steamcommunity.com/sharedfiles/filedetails/?id=3038334237 Terrors of the Depths]
| Creatures, [[Modding:Tiles]]
|-
| [https://gitlab.com/Armithaig/hearthpyre Armithaig/hearthpyre]
| [https://steamcommunity.com/sharedfiles/filedetails/?id=1683847053 Hearthpyre]
| [[Modding:C Sharp Scripting]], [[Modding:Sounds]], [[Modding:Tiles]]
|-
| [https://github.com/AsheIsAmazing/QudMods/ AsheIsAmazing/QudMods]
| Various mods
|
|-
| [https://github.com/HeladoDeBrownie/Caves-of-Qud-Minimods HeladoDeBrownie/Caves-Of-Qud-Minimods]
| Various mods
|
|-
| [https://github.com/Ilysen/Jademouth Ilysen/Jademouth]
| [https://steamcommunity.com/sharedfiles/filedetails/?id=2926820352 Jademouth]             
| [[Modding:Maps]], [[Modding:Quests]], [[Modding:Worlds]]
|-
| [https://github.com/kernelmethod/QudMods/ kernelmethod/QudMods]
| Various mods
|
|-
| [https://github.com/librarianmage/FinderOfRuin librarianmage/FinderOfRuin]
| [https://steamcommunity.com/sharedfiles/filedetails/?id=2812261314 FinderOfRuin]
| [[Modding:Harmony]], [[Modding:Options]]
|}


{{Modding Navbox}}
{{Modding Navbox}}

Navigation menu