Welcome =================================== .. toctree:: :caption: General :maxdepth: 3 :hidden: general/installing-mods general/mod-development .. toctree:: :caption: Blasphemous 1 mods :maxdepth: 3 :hidden: blas1-mods/multiplayer .. toctree:: :caption: Blasphemous 2 mods :maxdepth: 3 :hidden: blas2-mods/multiplayer .. toctree:: :caption: Creating mods for Blasphemous 1 :maxdepth: 3 :hidden: creating-mods-b1/index .. toctree:: :caption: Creating mods for Blasphemous 2 :maxdepth: 3 :hidden: creating-mods-b2/index Welcome to the **Blasphemous Modding Guides**! This is a documentation compiling guides for everyone that wants to use mods for `Blasphemous`_ or `Blasphemous II`_, or add content to those games. .. _Blasphemous: https://store.steampowered.com/app/774361/Blasphemous/ .. _Blasphemous II: https://store.steampowered.com/app/2114740/Blasphemous_2/ .. note:: This documentation is still under construction. Aim -------- The goal of this documentation is to provide the resources for everyone who is interested in using mods or adding content to one or both games, to be able to do so, and with an in depth knowledge. Of course this doesn't mean the information you find here only apply to those games, but it means that it probably not applies to every game you know. I am currently a newbie in modding, but I am having a lot of fun and learning a lot, and I want to help new comers, show the common pitfalls, help people who are curious but don't want to mod to understand how games are modded. Who is this for? -------- Everyone who is curious, this is not a technical documentation for mods reserved to developers, this is a compilation of guides with tutorials and explanations, even if you aren't playing any of the games mentioned, or have no intention of learning how to mod, this could still interest you! Other than that, this documentation was written with the following readers in mind: * Gamers who want to mod their games. * Linux users who want to be able to run mods for both native and non native games. * New mod developers, who want to have some sort of tutorial or guide to help them understand how mods are made. * Casual mod developers, who are looking for documented resources, like some sort of developer wiki, to easily find data or value used for mod development. * Skin makers, and other modding tools users, who aren't necessarily programmers or have any programming knowledge, but use tools like the Skin Maker. What can I find here? -------- The term "documentation" has been used a lot here, it will generally be used to refer to this site as a whole, which is a compilation of guides like said earlier, but to be more precise, this is what sort of guides you can find here: * Mainly tutorials & examples * Data sheets Anything I should know before continuing? -------- More detailed explanations can have a page of their own, but they will be mostly contained within note messages like this: .. note:: It behaves like this because internally it does this and that. So you can simply skip them if you do not care, or read them if you want to have more in depth knowledge. Important information will be contained within attention, caution or danger blocks like th following: .. attention:: This is some pretty important information you should read, if you don't want to misunderstand something and spend hours trying to figure out something simple. .. caution:: Please read this, this could cause some serious problems, like lose all you unsaved work or your game's saves! .. danger:: You should absolutely read this at all times! This could seriously put your game's saves or your work at risk! It is highly recommended to read those blocks, the attention blocks can be skipped if you are aware of what you are doing, but the other blocks should ideally always be read, and shouldn't contain too much text to read. Where do I start? -------- It depends on your needs. [TODO] By the way -------- I don't get any money from this, all of my projects are free and open-source, I don't have any donations box either, this is purely for enjoyment and helping others. Also no generative AI has been used to write everything here. Not even a little. I may use a translator for some words but it's all me and my C1 level English. And because of that, these guides may contain errors, if you see one and one to report it, it'd make me happy and help others by improving the quality of the guides. You can open an issue or pull request on the repository for this guide or contact me via Discord.