Modding - Revision history

Casiope at 17:04, 11 July 2020

2020-07-11T17:04:35Z

← Older revision		Revision as of 17:04, 11 July 2020
Line 1:		Line 1:
	{{message box warning\|This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}		{{message box warning\|This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The {{strong\|modding of the game}} is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.
	{{TOC limit\|3}}		{{TOC limit\|3}}

Casiope at 17:03, 11 July 2020

2020-07-11T17:03:58Z

Show changes

Casiope at 15:43, 21 June 2020

2020-06-21T15:43:30Z

← Older revision		Revision as of 15:43, 21 June 2020
Line 1:		Line 1:
	{{~~Message~~ box warning\|		{{message box warning\|This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}
	This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.

Casiope: Corrected typos. Removed duplicated message box. Removed previewed functionnalities that won't be updated (labels and main functions).

2020-05-18T14:11:39Z

Corrected typos. Removed duplicated message box. Removed previewed functionnalities that won't be updated (labels and main functions).

← Older revision		Revision as of 14:11, 18 May 2020
Line 1:		Line 1:
	{{Message box warning\|		{{Message box warning\|
	This API is ~~deprecated. The API is both~~ incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}		This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.
Line 6:		Line 6:

	== Hooking into the game ==		== Hooking into the game ==

	~~{{message box important\|This feature is incomplete as of version 0.18.6, the ModManager class is present, but no hooking of any kind can be done at the moment.}}~~

	=== Registration and enabling of the mod ===		=== Registration and enabling of the mod ===

Line 100:		Line 97:
	The mod screen hook is quite simple as it uses RenPy’s <code>use</code> statement for every modded screen. The screen hook is called at the end of each screen, so background set up and imagebuttons for the game are already properly shown and defined. You can then add your own imagebuttons, and other screen features to it.		The mod screen hook is quite simple as it uses RenPy’s <code>use</code> statement for every modded screen. The screen hook is called at the end of each screen, so background set up and imagebuttons for the game are already properly shown and defined. You can then add your own imagebuttons, and other screen features to it.

	Note : Hookable screens are, at least for now, only the location screens, and do not include the UI.		Note: Hookable screens are, at least for now, only the location screens, and do not include the UI.

	~~=== Labels ===~~

	~~{{Message box warning\|This code is not yet implemented.}}~~

	~~Only "main" {{strong\|labels}} can be hooked into. Those are labels that end in {{nowrap\|<code>$ game.main()</code>}}.~~

	~~=== Main function ===~~

	~~{{message box warning\|This code is not yet implemented.}}~~

	~~To hook into the {{strong\|main function}}, you must register your main function to the ModManager~~.

	<u>'''Example:'''</u>		<u>'''Example:'''</u>
Line 238:		Line 223:
	return text		return text
	</syntaxhighlight>		</syntaxhighlight>

	~~In the future, registering to <code>config.say_menu_text_filter</code> variable will be done with the <code>+=</code> assignment, to allow several mods to subscribe to it. Mod load order will apply.~~

	=== Location names ===		=== Location names ===

Sam9 at 17:26, 17 May 2020

2020-05-17T17:26:28Z

← Older revision		Revision as of 17:26, 17 May 2020
Line 1:		Line 1:
	{{Message box warning\|		{{Message box warning\|
	This API is ~~depreciated~~. The API is both incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}		This API is deprecated. The API is both incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.

Sam9 at 17:25, 17 May 2020

2020-05-17T17:25:14Z

← Older revision		Revision as of 17:25, 17 May 2020
Line 1:		Line 1:
			{{Message box warning\|
			This API is depreciated. The API is both incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.
	{{TOC limit\|3}}		{{TOC limit\|3}}

Casiope at 19:29, 15 January 2020

2020-01-15T19:29:45Z

← Older revision		Revision as of 19:29, 15 January 2020
Line 4:		Line 4:
	== Hooking into the game ==		== Hooking into the game ==

	{{~~Message~~ box important\|This feature is incomplete as of version 0.18.6, the ModManager class is present, but no hooking of any kind can be done at the moment.}}		{{message box important\|This feature is incomplete as of version 0.18.6, the ModManager class is present, but no hooking of any kind can be done at the moment.}}

	=== Registration and enabling of the mod ===		=== Registration and enabling of the mod ===
Line 81:		Line 81:
	=== Mod init order ===		=== Mod init order ===

	{{~~Message~~ box information\|Mods are assumed to be in an initial random order.}}		{{message box information\|Mods are assumed to be in an initial random order.}}

	For every mod that is enabled, create a Mod instance with that mod’s name, parse the load order from the manifest, then insert that mod in the <code>ModManager.mods</code> list in the proper position. Then, for every mod in the <code>ModManager.mods</code> list, call their init label, if defined. Finally, update the game stores (i.e. achievements, items and text_messages) with every data of the mod. Updates overwrite the keys, so the load order can be used to overwrite the game’s (although ill‐advised) or another mod’s items/text_messages/achievements.		For every mod that is enabled, create a Mod instance with that mod’s name, parse the load order from the manifest, then insert that mod in the <code>ModManager.mods</code> list in the proper position. Then, for every mod in the <code>ModManager.mods</code> list, call their init label, if defined. Finally, update the game stores (i.e. achievements, items and text_messages) with every data of the mod. Updates overwrite the keys, so the load order can be used to overwrite the game’s (although ill‐advised) or another mod’s items/text_messages/achievements.
Line 107:		Line 107:
	=== Main function ===		=== Main function ===

	{{~~Message~~ box warning\|This code is not yet implemented.}}		{{message box warning\|This code is not yet implemented.}}

	To hook into the {{strong\|main function}}, you must register your main function to the ModManager.		To hook into the {{strong\|main function}}, you must register your main function to the ModManager.

Casiope at 15:54, 2 January 2020

2020-01-02T15:54:11Z

← Older revision		Revision as of 15:54, 2 January 2020
Line 95:		Line 95:
	To ensure proper game progression, you shoul only add imagebuttons. Please refer to {{section link\|Summertime Saga API#User-defined screen actions}} for more information on which screen actions the game defines.		To ensure proper game progression, you shoul only add imagebuttons. Please refer to {{section link\|Summertime Saga API#User-defined screen actions}} for more information on which screen actions the game defines.

	The mod screen hook is quite simple as it uses ~~RenPy's~~ <code>use</code> statement for every modded screen. The screen hook is called at the end of each screen, so background set up and imagebuttons for the game are already properly shown and defined. You can then add your own imagebuttons, and other screen features to it.		The mod screen hook is quite simple as it uses RenPy’s <code>use</code> statement for every modded screen. The screen hook is called at the end of each screen, so background set up and imagebuttons for the game are already properly shown and defined. You can then add your own imagebuttons, and other screen features to it.

	Note : Hookable screens are, at least for now, only the location screens, and do not include the UI.		Note : Hookable screens are, at least for now, only the location screens, and do not include the UI.

Dogeek: /* Screens */

2019-09-26T15:34:39Z

Screens

← Older revision		Revision as of 15:34, 26 September 2019
Line 92:		Line 92:
	=== Screens ===		=== Screens ===

	{{~~Message box warning~~\|~~This~~ code ~~is not yet implemented~~.}}		Create your {{strong\|screens}} with the following convention: <code>modname</code> + <code>_</code> + <code>in‐game screen name</code> (the Ren’Py definition name). Screens are being included into the main game screens with the use statement. If you wish to add new locations, you have to define a screen for it, in which case, you can inspire yourself with the existing screens in the game.<br>
			To ensure proper game progression, you shoul only add imagebuttons. Please refer to {{section link\|Summertime Saga API#User-defined screen actions}} for more information on which screen actions the game defines.

	~~Create your {{strong\|screens}} with the following convention:~~ <code>~~modname~~</code> ~~+ <code>_</code> + <code>in‐game~~ screen ~~name</code> (~~the ~~Ren’Py definition name). Screens are being included into~~ the ~~main~~ game ~~screens with the use statement~~. ~~If you wish to~~ add ~~new locations~~, ~~you have~~ to ~~define a screen for~~ it~~, in which case, you can inspire yourself with the existing screens in the game~~.~~<br>~~		The mod screen hook is quite simple as it uses RenPy's <code>use</code> statement for every modded screen. The screen hook is called at the end of each screen, so background set up and imagebuttons for the game are already properly shown and defined. You can then add your own imagebuttons, and other screen features to it.
	~~To add the proper background~~, ~~start with~~ the ~~statement {{nowrap\|<code>add player.~~location~~.background</code>}}~~, ~~which automatically shows~~ the proper background according to the time of day/period of the year. You can then add imagebuttons. Please refer to {{section link\|Summertime Saga API#User-defined screen actions}} for more information on which screen actions the game defines.
			Note : Hookable screens are, at least for now, only the location screens, and do not include the UI.

	=== Labels ===		=== Labels ===

Casiope at 15:17, 28 August 2019

2019-08-28T15:17:34Z

← Older revision		Revision as of 15:17, 28 August 2019
Line 246:		Line 246:
	L_map.display_name = "New Map Name"		L_map.display_name = "New Map Name"
	</syntaxhighlight>		</syntaxhighlight>

			[[Category:Community]]

← Older revision		Revision as of 17:04, 11 July 2020
Line 1:		Line 1:
	{{message box warning\|This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}		{{message box warning\|This API is depreciated: the features are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

	The modding of the game is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.		The {{strong\|modding of the game}} is based on the Summertime Saga API. It is recommended to read the [[Summertime Saga API\|corresponding article]] beforehand in order to familiarize yourself with the specificities of the code.
	{{TOC limit\|3}}		{{TOC limit\|3}}