Updating Lua Projects from 1.0.0 to 1.0.1

[Josh]

Version 1.0.1 makes some final changes that should only be made while the software is still in early access. Once it goes full release, I would not make breaking changes to the design unless there was a very good reason, so it's best to do this now.

• For Lua projects, the "Source" folder should be renamed to "Scripts". This will better support future plans for C++ games that are moddable with Lua script, and is also more cohesive with the Leadwerks 4 way of doing things.
• All entity definition JSON files have been moved into a folder in your game directory called "Entity Definitions". This resolves the conflict between the location of C++ and Lua code files, and also will make moddable games easier to distribute in the future.
• The Lua import function now works with relative paths, which is more consistent with other programming languages. If you want to import a Lua script file that is in the same folder, you just need to specificy the name of the file, with no directory.

Updating Projects

Before you start, it's a good idea to make a copy of your game folder before updating your project.

When you open a Lua project, and a folder named /Source is detected, the editor will prompt you to update the project:

When you press OK, the editor will rename the "Source" folder to "Scripts" and move all entity definition JSON files into a folder called "Entity Definitions".

If you run the game at this point, you will see several errors saying something like "Failed to read file Source\System\ErrorHandler.lua". This is because you are still using the Lua executables from the previous version, and you need to update them.

Open the project manager by selecting the File > Project manager menu item in the main menu. Click on the orange warning icon.

Among other files, you will see the two game executables, for release and debug mode

Press OK to update the project and get the new files. After that, your game will run.

Any overwritten files will have a backup copy made in the "Backup" folder, in your game's directory.

If you don't want .lua files to be overwritten in the future, open the program options from the Tools > Options menu item in the main menu. Under Projects > Never update files, add *.lua to the property in the list of file filters.

The changes in version 1,0.1 need to be made before the program exits early access, not after. I do not expect any changes this big in future updates.