| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| democap:modding [2024/07/26 09:57] – [Project Preparation] dragonlord | democap:modding [2024/09/06 09:33] (current) – [Modding] dragonlord |
|---|
| DEMoCap supports modifications developer by anybody using the [[https://mod.io/g/democap|Mod.io]] platform. Various modifications can be made including (but not limited to): characters, props, worlds and script code. | DEMoCap supports modifications developer by anybody using the [[https://mod.io/g/democap|Mod.io]] platform. Various modifications can be made including (but not limited to): characters, props, worlds and script code. |
| |
| | ====== Examples ====== |
| | |
| | Example modifications can be found on the [[https://github.com/LordOfDragons/democap/tree/main/modding/examples|Github Repository]]. |
| ====== Using Modifications ====== | ====== Using Modifications ====== |
| |
| Under ''Base Packages'' click on ''Edit in settings.json''. This opens again the settings file placing the cursor at the ''dragonscriptLanguage.basePackages'' setting. Here you can enter the ''*.delga'' file of DEMoCap. This will make the DEMoCap script files available in the project. To find the correct path you can launch from the start menu ''Drag[en]gine GUI Launcher''. On Linux you can also run ''delauncher-gui'' from a terminal window. Find the ''DEMoCap'' game entry in the list and <key>RMB</key> click on it. Select ''Properties''. In the dialog window locate the ''DELGA:'' value. This is the path to the last known location of DEMoCap. Copy this path and enter it into the ''dragonscriptLanguage.scriptDirectories'' list. | Under ''Base Packages'' click on ''Edit in settings.json''. This opens again the settings file placing the cursor at the ''dragonscriptLanguage.basePackages'' setting. Here you can enter the ''*.delga'' file of DEMoCap. This will make the DEMoCap script files available in the project. To find the correct path you can launch from the start menu ''Drag[en]gine GUI Launcher''. On Linux you can also run ''delauncher-gui'' from a terminal window. Find the ''DEMoCap'' game entry in the list and <key>RMB</key> click on it. Select ''Properties''. In the dialog window locate the ''DELGA:'' value. This is the path to the last known location of DEMoCap. Copy this path and enter it into the ''dragonscriptLanguage.scriptDirectories'' list. |
| <WRAP center round important 60%> | <WRAP center round important 60%> |
| On Windows only make sure to replace each single ''\'' with double ''\\'' otherwise the directory will not be found. | On Windows make sure to replace each single ''\'' in the path with double ''\\''. Otherwise the directory will not be found and you miss IDE support for DEMoCap script classes. |
| </WRAP> | </WRAP> |
| |
| Open file browser with path ''~/.config/delauncher/games/e31f1c11-3ca6-c66b-adca-95484bedfc1f''. Create directory ''overlay''. Content in this directory will be overlaid in DEMoCap. Open the ''overlay'' directory. Open your ''MyMod'' directory in another file browser. Create symbolic links of ''content'' and ''scripts'' into the ''overlay'' directory. | Open file browser with path ''~/.config/delauncher/games/e31f1c11-3ca6-c66b-adca-95484bedfc1f''. Create directory ''overlay''. Content in this directory will be overlaid in DEMoCap. Open the ''overlay'' directory. Open your ''MyMod'' directory in another file browser. Create symbolic links of ''content'' and ''scripts'' into the ''overlay'' directory. |
| |
| Now when you run DEMoCap your modification content will be used as if a user has installed your final modification. Once you are finished developing your modification remove these two symbolic links. | Now when you run DEMoCap your modification content will be used as if a user has installed your final modification. |
| |
| ==== Windows ==== | ==== Windows ==== |
| Replace ''C:\Users\DragonDreams\MyMod'' with the path to your ''MyMod'' directory. These calls create first the ''overlay'' directory. Then the ''content'' and ''scripts'' directories from inside your ''MyMod'' directory are symbolic-linked to the ''overlay'' directory. | Replace ''C:\Users\DragonDreams\MyMod'' with the path to your ''MyMod'' directory. These calls create first the ''overlay'' directory. Then the ''content'' and ''scripts'' directories from inside your ''MyMod'' directory are symbolic-linked to the ''overlay'' directory. |
| |
| Now when you run DEMoCap your modification content will be used as if a user has installed your final modification. Once you are finished developing your modification remove these two symbolic links. | Now when you run DEMoCap your modification content will be used as if a user has installed your final modification. |
| | <WRAP center round important 60%> |
| | Once you are finished developing your modification remove these two symbolic links (''content'' and ''scripts'' directories). Otherwise they keep overlaying DEMoCap even if you test-install your own modification after uploading it to Mod.io. |
| | </WRAP> |
| |
| ===== Content Modifications ===== | ===== Content Modifications ===== |
| end | end |
| </code> | </code> |
| | <WRAP center round important 60%> |
| The ''namespace'' line is important. DEMoCap searches for modification script files only in this namespaces. | The ''namespace'' line is important. DEMoCap searches for modification script files only in this namespace. |
| | </WRAP> |
| |
| Use for ''MyModification'' a unique namespace name for your modification to keep files from mixing with other modifications. Place your script files in this namespace. You can choose your file structure as you like. It is not required to mirror namespace structure but doing so can help organize your files. | Use for ''MyModification'' a unique namespace name for your modification to keep files from mixing with other modifications. Place your script files in this namespace. You can choose your file structure as you like. It is not required to mirror namespace structure but doing so can help organize your files. |
