Apply patch / update to exported game does not load new scripts.

GregoryAM

Does the issue occur in the editor or during gameplay?
Gameplay - This is for Exported Games

If it's a gameplay issue, please specify which movement system and camera type you're using (free movement vs. grid movement, third-person vs. first-person) or N/A if not applicable:
N/A

Briefly describe the issue you're experiencing:
Applying patches / updates after exporting the game will result in scripts not being applied or working.

Are there any errors in the in-game debug console or external console window?
No. The new map is loaded, but inaccessible through scripts, only the debug console.

Provide the steps necessary to reproduce the issue:
1.0 ) Create a single map and export the game (My Game v1.0.0).
1.5 ) Play the exported game and save game.
2.0 ) Create a new map and link the new map using a tile on the existing map.
3.0 ) Export the new game and save it in a new folder (My Game v1.0.1).
3.5 ) Copy the PCK file from v1.0.1 to v1.0.0 replacing the old PCK file.
4.0 ) Play "My Game v1.0.0" exe (v1.0.1 PCK file in directory), and "Continue" when loaded.
4.5 ) Go-to location of added script (does not execute).

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

If the user creates a new game, everything works as intended.

If the user continues a saved game, new scripts added do not work.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Going to the tile that was created in v1.0.1, the script to load the new map does not work.

Using command load_map("second_map", coords[0, 0, 0], SOUTH) in the debug console will teleport the player to the new map, but the script that's on the tile with the same command is not working after applying the patch / update.

This applies to different assets:
NPC's with new scripts added / changed.
Tiles with new scripts added / changed.
Scripts added / changed in the game.
Will update if others are found

Justin advised me to use Itch.io's Butler tool to apply patches and updates to the game.

I personally would like to be able to create copies on my drive to test the updates before applying them or using the Butler tool to make sure all assets are working properly.

Justin

GregoryAM Thanks for the report! I'm not sure I follow completely in regards to the issue. I think in this case it would be helpful to have a minimal bare bones project set up where I can observe the specific issue occurring along with directions to reproduce it (e.g. start up the provided game, perform action X, observe that Y should happen but doesn't).

GregoryAM

I was able to test the Butler Tool (CLI) that Itch.io provides;
While this is convenient to update the game; It still does not have the desired effects of what an update would do.

Say; The player is on a specific map. I push an update. the map the player was on has a new NPC and a new script.

The new NPC will show, but the script attached to the NPC does not execute.
Same goes for a Tile that has a script to move the player from one part of the map to another.

An "Under construction" part of the map would be rendered completely impossible to get to. This is because the player would have to completely restart the entire game in order to view the newly constructed part of the map.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

While I understand RPG in a Box is still in development, I do hope to see this as an addition!
It would definitely make updating games made with RPG in a Box 100% better and easier!

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Kudos to Justin though for implementing everything we know and love within this software!

GregoryAM

Justin

I'll put together a zip file that contains a text file and project files with instructions on how to reproduce this!

I'll do everything I can to make sure I include detailed instructions. Since I know I wrote this bug report incredibly quickly.

GregoryAM

Justin

Introduction

Included in this ZIP Archive (Update Test - RPG in a Box.zip) are two identical RPG in a Box Projects.

Update Test v1.0.0
Update Test v1.0.1

I have included Exported versions of the game to quickly swap the game.pck files.

Update Test v1.0.0 - Windows x64
Update Test v1.0.0 - Linux
Update Test v1.0.0 - MacOS
=-=-=-=-=-=-=-=-=-=-=-=-=-=
Update Test v1.0.1 - Windows x64
Update Test v1.0.1 - Linux
Update Test v1.0.1 - MacOS

In the MacOS Export, game.pck is located at:
"./Update Test v1.0.0 - Export (MacOS)/Game.app/Contents/Resources/rpginabox.pck"

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Project information

"Update Test v1.0.0" is a "Bare Bone Project" with no modifications.

"Update Test v1.0.1" is a "Bare Bone Project" that includes the following modifications:

A Sign placed at coord[-1, -5, 0] in Map "overworld" with a player interacts trigger event.
A New Map called "new_overworld"
A Sign placed at coord[0, 2, 1] in "new_overworld" with a player interacts trigger event.
A Script called "load_new_map" to load_map("new_overworld", coord[0, 0, 0], SOUTH)
^{> Executed from the Sign located in Map "overworld".}

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

- Steps to Reproduce Update / Patch Issue -

Download the attached ZIP Archive "Update Test - RPG in a Box.zip".
Extract the downloaded archive to a location on your computer.

NOTE: Remember the location of the extracted archive, you will go back to it a few times.

Update Test v1.0.0

Do one of the following:

Open "Update Test v1.0.0" in RPG in a Box and Export Game.
^{> Run the Game after Export}
Run one of the pre-exported games from directory "Update Test v1.0.0 Exported".

NOTE:

This Game DOES NOT include a Sign to the North of the player.

This Game DOES NOT include the map new_overworld.

This Game DOES NOT include the script load_new_map.

Close this game.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Update Test v1.0.1

Do one of the following:

Open "Update Test v1.0.1" in RPG in a Box and Export Game.
^{> Run the Game after Export}
Run one of the pre-exported games from directory "Update Test v1.0.1 Exported".

NOTE:

This Game DOES include a Sign to the North of the player.
^{> Interacting with this sign will load the New Map "new_overworld".}

This Game DOES include the map new_overworld.

This Games DOES include the script load_new_map.

Close this game.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Before continuing with this section, please make a copy of the Update Test v1.0.0 game.pck and place it somewhere notable. We will be needing this for the (After Saving Game) section.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Patching / Updating Game (Before Saving Game)

Replace the game.pck file from Update Test v1.0.0 with the game.pck from Update Test v1.0.1.

This is essentially "updating / patching" the games assets; including but not limited to scripts, scenes, shaders, models, textures, sound effects, music and any other assets.
^{> Source: Overview of PCK files}

The map will load the new assets as normal.
^{> New Map and newly added Sign to existing map: overworld.}
The map will load newly added scripts as normal.
^{> New Script to load newly added map: load_new_map.}

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Patching / Updating Game (After Saving Game)

Replace the Update Test v1.0.0 game.pck file with the copy you've created.
^{> Mentioned above at the start of this section.}

Do one of the following:

Open "Update Test v1.0.0" in RPG in a Box and Export Game.
^{> Run the Game after Export}
Run one of the pre-exported games from the directory "Update Test v1.0.0".

NOTE: This Game should be the Bare Bone Project with no modifications.

Save the game!
Close this game.
Replace the game.pck from "Update Test v1.0.0" with the game.pck from "Update Test v1.0.1".
Open "Update Test v1.0.0" Game.
Continue / Resume Saved Game

Assets from "Update Test v1.0.1" are visible within "Update Test v1.0.0"; the game.pck is now "updated / patched";

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Issue with Saved Game:

After loading into the `Saved game`:

You will notice that the Sign we placed from "Update Test v1.0.1" is visible on the map when running the "game.exe" from "Update Test v1.0.0".

However, interacting with the Sign will not load the new map: new_overworld.

Assets did update, but triggering the scripts did not.

You can load the new map using the Debug Console using command:
load_map("new_overworld", coord[0, 0, 0], SOUTH)

The command is the only way to load or visit the new map, unless the user completely restarts the game with: New game.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Desired Outcome:

Updating / Patching the game by replacing game.pck should introduce the newly added content into Saved games.

While it does introduce Models, NPC's, and other assets to an existing map, their scripts do not work.

Similar to my previous Reply:

An "Under construction" area of the map would be impossible to get to; because the script to load the new area / map does not execute.

This also includes:

NPC Scripts (updated or added)
^{Changing NPC A.I.}
Tile Scripts (updated or added)
^{User interacting with Tiles in a map.}
Interactable Scripts (updated or added)
^{Scripts attached to an Object or NPC that the player interacts with.}
Updated Scripts
^{Pre-existing scripts that are updated or changed.}
Global Scripts
^{Saving / Loading changes; introducing new variables.}
And others...

(Google Drive): Update Test - RPG in a Box.zip

Realized I left in the README.txt that was just a draft of this reply.

Also, sorry that this is a lot!
I will also make a YouTube video demonstrating this.

GregoryAM

Justin

GregoryAM Thank you for the additional details!

GregoryAM

I have just realized, that doing it this way will treat the game.pck from "Update Test v1.0.0" and "Update Test v1.0.1" as separate games since the game.cfg within the game.pck have different Window Titles.

This means, "Update Test v1.0.0" and "Update Test v1.0.1" will have it's own save file and data within Application Data (%appdata%) on Windows.

I will definitely be making a video.

GregoryAM

There was an issue that I cannot reproduce, where when you save a game with hostile Justin and remove the hostility, it will crash the game. I was unable to reproduce it and did not capture it on camera.

GregoryAM

GregoryAM
Okay, so the issue happens when you add an NPC then remove the NPC from the game then load into the saved game.

This is the error that happens.

This is after replacing the game.pck file from a game that had the NPC and then loading into the save.
The player cannot move and this error floods the console.

GregoryAM

Replying to this thread to say that this has been fixed with v1.2 release.

Stumpy

GregoryAM So happy to hear that this is fixed now! Thank you for following up.