SkyTemple: Difference between revisions

(9 intermediate revisions by 3 users not shown)

Line 1:

[[SkyTemple]] is a ROM editor for the video game "Pokémon Mystery Dungeon Explorers of Sky" ([[SkyTemple:General disclaimer|not official]]). It allows you to edit almost any aspect of the game, from the game's [[Script scenes~~|Script Scenes~~]], to [[Pokémon Data]] and [[Dungeon ~~Data~~|Dungeons]].

[[SkyTemple]] is a ROM editor for the video game "Pokémon Mystery Dungeon Explorers of Sky" ([[SkyTemple:General disclaimer|not official]]). It allows you to edit almost any aspect of the game, from the game's [[Script Engine|script scenes]], to [[Pokémon Data|Pokémon data]] and [[Dungeon Properties|Dungeons]].

The editor is split into multiple sections which let you edit the various aspects of the game.

Line 15:

To load a ROM file, select the "Open" button in the top-left of the application. You can find a list of recently opened ROMs here or select "More Files" to browse for a ROM file.

Supported are all valid Nintendo DS ROM files that identify themselves as Pokémon Mystery Dungeon Explorers of Sky ~~in either the european or american version. The japanese version is not yet supported~~. ~~You~~ can also open most ROM hacks of ~~said~~ game, unless the author of the hack has implemented measures that prevent SkyTemple from detecting it as a valid ROM of the game.

Supported are all valid Nintendo DS ROM files (.nds files) that identify themselves as Pokémon Mystery Dungeon: Explorers of Sky. It can also open most ROM hacks of the game, unless the author of the hack has implemented measures that prevent SkyTemple from detecting it as a valid ROM of the game.

== Menu ~~Options~~ ==

== Menu options ==

On the top-right of the application you find various options.

Line 29:

** ''"Settings..."'': Opens the [[SkyTemple Settings|Settings]] dialog, which allows you to configure global settings for the application.

** ''"Open Image Converter..."'': Opens the [[Tilequant]] image converter. This converter allows you to convert any image in the formats needed by the game.

** ''"Open SpriteCollab Browser..."'': Opens the [[SpriteCollab Browser]], which allows you to download [[Pokémon Portrait|Pokémon portraits]] and [[~~Pokémon~~ Sprite|sprites]] from the community.

** ''"Open SpriteCollab Browser..."'': Opens the [[SpriteCollab Browser]], which allows you to download [[Pokémon Portrait|Pokémon portraits]] and [[Monster Sprite|sprites]] from the community.

** ''"Open config directory..."'': This opens the SkyTemple application configuration directory in your file browser. This directory also contains the log files SkyTemple generates, which can be useful if you encounter issues to report them.

** ''"About"'': Opens a dialog that shows you the authors of SkyTemple, the license and the version of SkyTemple you are currently running.

Line 43:

=== {{SkyTempleIcon|icon=skytemple-e-patch-symbolic}} Patches ===

The '''Patches''' section allows you to apply bundled ASM patches that modify the game in substantial ways. It also allows you to load user-created ASM patches or your own and explains how to apply patches written in Rust or C.

The '''Patches''' section allows you to apply bundled [[ASM Patch|ASM patches]] that modify the game in substantial ways. It also allows you to load [[Skypatch File|user-created ASM patches]] or your own and explains how to apply patches written in Rust or C.

=== {{SkyTempleIcon|icon=skytemple-view-list-symbolic}} Lists ===

Line 53:

=== {{SkyTempleIcon|icon=skytemple-e-ground-symbolic}} Script Scenes ===

'''Script Scenes''' are arrangements of [[Actor|NPCs]], [[Object|objects]], [[performer]] (camera) and [[Triggers and Events|triggers]] on the overworld. This section lets you edit the layout and composition of these scenes, while the actual scenes are scripted and can be edited using the [[SkyTemple#Script Engine Debugger|Script Engine Debugger]].

'''Script [[Scene|Scenes]]''' are arrangements of [[Actor|NPCs]], [[Object|objects]], [[performer]] (camera) and [[Triggers and Events|triggers]] on the overworld. This section lets you edit the layout and composition of these scenes, while the actual scenes are scripted and can be edited using the [[SkyTemple#Script Engine Debugger|Script Engine Debugger]].

=== {{SkyTempleIcon|icon=skytemple-e-monster-symbolic}} Pokémon ===

Line 91:

The game has various other graphics for all kinds of purposes, which you can edit in the '''Misc. Graphics''' section.

=== {{SkyTempleIcon|icon=skytemple-e-patch-symbolic}} Symbols ===

The '''Symbols''' section allows you to edit some internal values of the game that are normally hardcoded.

== Script Engine Debugger ==

By clicking the [[File:SkyTemple Script Engine Debugger Logo.png|alt=SkyTemple Script Engine Debugger Logo (a bug/beetle)|16x16px]] (bug) icon in the top bar of the editor, you can launch the SkyTemple Script Engine Debugger.

With this tool you can test your game inside a bundled emulator and modify the code of the game's ~~[[Script Scene|Script Scenes]]~~. While the [[SkyTemple#Script Scenes|Script Scenes section]] in the main UI lets you edit the layout of the scenes (such as NPC placements), the actual [[Script|scripts]] that run these scenes can be edited here. These scenes are used almost everywhere in the game outside of the main menu, dungeons and most of the personality quiz and shop menus. They are used for cutscenes, NPC interaction all player-controlled overworld maps.

With this tool you can test your game inside a bundled emulator and modify the code of the game's script scene. While the [[SkyTemple#Script Scenes|Script Scenes section]] in the main UI lets you edit the layout of the [[Scene|scenes]] (such as NPC placements), the actual [[Script|scripts]] that run these scenes can be edited here. These scenes are used almost everywhere in the game outside of the main menu, dungeons and most of the personality quiz and shop menus. They are used for cutscenes, NPC interaction all player-controlled overworld maps. The game runs them in the so-called "Ground Mode" using its [[Script Engine]].

== Project ~~Directory~~ and sharing your game ==

== Project directory and sharing your game ==

When you open a ROM in SkyTemple, the app will create a directory next to the ROM file, it is named the same as the ROM file suffixed with ".skytemple". This directory can safely be deleted and is not needed to play the ROM, ''however'' it contains information that is very useful for editing the game. This includes the source code for all [[Script|scripts]] you edited and macro files. If you delete the directory SkyTemple will decompile scripts again, which leaves them in a rather unreadable state and removes all comments you made.

To share the ROM Hack / mod you made, save the ROM in SkyTemple and create a patch file from your game based on a clean copy of the original game ROM. You don't need to share the project directory. '''Never''' share the ".nds" file itself, only patch files. See the [[Frequently Asked Questions#How do I ~~test later dungeons in the game.3F Can I jump ahead in the story~~.3F|FAQ]] for more information.

To share the ROM Hack / mod you made, save the ROM in SkyTemple and create a patch file from your game based on a clean copy of the original game ROM. You don't need to share the project directory. '''Never''' share the ".nds" file itself, only patch files. See the [[Frequently Asked Questions#How can I publish my hack so other people can play it.3F|FAQ]] for more information.

== Reporting issues ==

@@ Line 1: / Line 1: @@
-[[SkyTemple]] is a ROM editor for the video game "Pokémon Mystery Dungeon Explorers of Sky" ([[SkyTemple:General disclaimer|not official]]). It allows you to edit almost any aspect of the game, from the game's [[Script scenes|Script Scenes]], to [[Pokémon Data]] and [[Dungeon Data|Dungeons]].
+[[SkyTemple]] is a ROM editor for the video game "Pokémon Mystery Dungeon Explorers of Sky" ([[SkyTemple:General disclaimer|not official]]). It allows you to edit almost any aspect of the game, from the game's [[Script Engine|script scenes]], to [[Pokémon Data|Pokémon data]] and [[Dungeon Properties|Dungeons]].
 The editor is split into multiple sections which let you edit the various aspects of the game.
@@ Line 15: / Line 15: @@
 To load a ROM file, select the "Open" button in the top-left of the application. You can find a list of recently opened ROMs here or select "More Files" to browse for a ROM file.
-Supported are all valid Nintendo DS ROM files that identify themselves as Pokémon Mystery Dungeon Explorers of Sky in either the european or american version. The japanese version is not yet supported. You can also open most ROM hacks of said game, unless the author of the hack has implemented measures that prevent SkyTemple from detecting it as a valid ROM of the game.
+Supported are all valid Nintendo DS ROM files (.nds files) that identify themselves as Pokémon Mystery Dungeon: Explorers of Sky. It can also open most ROM hacks of the game, unless the author of the hack has implemented measures that prevent SkyTemple from detecting it as a valid ROM of the game.
-== Menu Options ==
+== Menu options ==
 On the top-right of the application you find various options.
@@ Line 29: / Line 29: @@
 ** ''"Settings..."'': Opens the  [[SkyTemple Settings|Settings]] dialog, which allows you to configure global settings for the application.
 ** ''"Open Image Converter..."'': Opens the [[Tilequant]] image converter. This converter allows you to convert any image in the formats needed by the game.
-** ''"Open SpriteCollab Browser..."'': Opens the [[SpriteCollab Browser]], which allows you to download [[Pokémon Portrait|Pokémon portraits]] and [[Pokémon Sprite|sprites]] from the community.
+** ''"Open SpriteCollab Browser..."'': Opens the [[SpriteCollab Browser]], which allows you to download [[Pokémon Portrait|Pokémon portraits]] and [[Monster Sprite|sprites]] from the community.
 ** ''"Open config directory..."'': This opens the SkyTemple application configuration directory in your file browser. This directory also contains the log files SkyTemple generates, which can be useful if you encounter issues to report them.
 ** ''"About"'': Opens a dialog that shows you the authors of SkyTemple, the license and the version of SkyTemple you are currently running.
@@ Line 43: / Line 43: @@
 === {{SkyTempleIcon|icon=skytemple-e-patch-symbolic}} Patches ===
 {{Main|Patches Section}}
-The '''Patches''' section allows you to apply bundled ASM patches that modify the game in substantial ways. It also allows you to load user-created ASM patches or your own and explains how to apply patches written in Rust or C.
+The '''Patches''' section allows you to apply bundled [[ASM Patch|ASM patches]] that modify the game in substantial ways. It also allows you to load [[Skypatch File|user-created ASM patches]] or your own and explains how to apply patches written in Rust or C.
 === {{SkyTempleIcon|icon=skytemple-view-list-symbolic}} Lists ===
 {{Main|Lists Section}}
@@ Line 53: / Line 53: @@
 === {{SkyTempleIcon|icon=skytemple-e-ground-symbolic}} Script Scenes ===
-{{Main|Script Scenes}}
+{{Main|Script Engine}}
-'''Script Scenes''' are arrangements of [[Actor|NPCs]], [[Object|objects]], [[performer]] (camera) and [[Triggers and Events|triggers]] on the overworld. This section lets you edit the layout and composition of these scenes, while the actual scenes are scripted and can be edited using the [[SkyTemple#Script Engine Debugger|Script Engine Debugger]].
+'''Script [[Scene|Scenes]]''' are arrangements of [[Actor|NPCs]], [[Object|objects]], [[performer]] (camera) and [[Triggers and Events|triggers]] on the overworld. This section lets you edit the layout and composition of these scenes, while the actual scenes are scripted and can be edited using the [[SkyTemple#Script Engine Debugger|Script Engine Debugger]].
 === {{SkyTempleIcon|icon=skytemple-e-monster-symbolic}} Pokémon ===
@@ Line 91: / Line 91: @@
 The game has various other graphics for all kinds of purposes, which you can edit in the '''Misc. Graphics''' section.
+=== {{SkyTempleIcon|icon=skytemple-e-patch-symbolic}} Symbols ===
+{{Main|Symbols}}
+The '''Symbols''' section allows you to edit some internal values of the game that are normally hardcoded.
 == Script Engine Debugger ==
 {{Main|Script Engine Debugger}}
 By clicking the [[File:SkyTemple Script Engine Debugger Logo.png|alt=SkyTemple Script Engine Debugger Logo (a bug/beetle)|16x16px]] (bug) icon in the top bar of the editor, you can launch the SkyTemple Script Engine Debugger.
-With this tool you can test your game inside a bundled emulator and modify the code of the game's [[Script Scene|Script Scenes]]. While the [[SkyTemple#Script Scenes|Script Scenes section]] in the main UI lets you edit the layout of the scenes (such as NPC placements), the actual [[Script|scripts]] that run these scenes can be edited here. These scenes are used almost everywhere in the game outside of the main menu, dungeons and most of the personality quiz and shop menus. They are used for cutscenes, NPC interaction all player-controlled overworld maps.
+With this tool you can test your game inside a bundled emulator and modify the code of the game's script scene. While the [[SkyTemple#Script Scenes|Script Scenes section]] in the main UI lets you edit the layout of the [[Scene|scenes]] (such as NPC placements), the actual [[Script|scripts]] that run these scenes can be edited here. These scenes are used almost everywhere in the game outside of the main menu, dungeons and most of the personality quiz and shop menus. They are used for cutscenes, NPC interaction all player-controlled overworld maps. The game runs them in the so-called "Ground Mode" using its [[Script Engine]].
-== Project Directory and sharing your game ==
+== Project directory and sharing your game ==
 When you open a ROM in SkyTemple, the app will create a directory next to the ROM file, it is named the same as the ROM file suffixed with ".skytemple". This directory can safely be deleted and is not needed to play the ROM, ''however'' it contains information that is very useful for editing the game. This includes the source code for all [[Script|scripts]] you edited and macro files. If you delete the directory SkyTemple will decompile scripts again, which leaves them in a rather unreadable state and removes all comments you made.
-To share the ROM Hack / mod you made, save the ROM in SkyTemple and create a patch file from your game based on a clean copy of the original game ROM. You don't need to share the project directory. '''Never''' share the ".nds" file itself, only patch files. See the [[Frequently Asked Questions#How do I test later dungeons in the game.3F Can I jump ahead in the story.3F|FAQ]] for more information.
+To share the ROM Hack / mod you made, save the ROM in SkyTemple and create a patch file from your game based on a clean copy of the original game ROM. You don't need to share the project directory. '''Never''' share the ".nds" file itself, only patch files. See the [[Frequently Asked Questions#How can I publish my hack so other people can play it.3F|FAQ]] for more information.
 == Reporting issues ==