Cyclops Level Builder lets you quickly build environments in the Godot viewport. Click and drag to create and edit blocks. Use the material editor to assign materials. All blocks have collision, so you will be able to interact with them right away.
Cyclops Level Builder works with Godot version 4 and later. There are no plans to backport it to 3 since there have been a lot of changes to both GDScript and Godot objects between the two and such a port would not be easy to do.
- Download the latest release from the releases page. Unzip it into a temporary directory.
- Copy the /addons folder and everything in it into the root of the project you want to use Cyclops Level Builder in.
- Click on Project/Project Settings. Select the Plugins tab and check Enable next to the Cyclops Level Builder entry.
It is strongly recommended that you make a backup of your project before you upgrade or change your version of Cyclops Level Builder.
You may notice a lot of errors being thrown when you first open your project after upgrading to a newer version of Cyclops. This is due to a problem with the way the Godot editor keeps track of class names. If a class is renamed or moved, Godot can become confused and no longer be able to find it which can cause a lot of error messages or even a crash. Godot also saves this information, so the problem can persist even if you close and reopen Godot. Fortunately, closing and reopening your project twice can usually cause Godot to rebuild its name cache. If you notice error messages after changing to a different version of Cyclops, please close and reopen your project in the editor twice to allow Godot to recalculate its name index.
If you're upgrading your project from Cyclops v1.0, v1.0.1 or an earlier development version of v1.0.2, you will need to upgrade your CyclopsBlocks object. To do this, simply select your CyclopsBlocks object in the Scene outliner and click the Upgrade button that appears in the toolbar. This will create a new subtree in your scene where the CyclopsConvexBlock objects are replaced with the new CyclopsBlock object. Your old CyclopsBlocks will still be there, but with its visibility turned off. You can now delete the CyclopsBlocks object if you no longer require it.
Documentation for using Cyclops Level Builder is available here.
An overview of the architecture of Cyclops Level Builder for those who want to dive into the code.
Please open small issues. PRs are welcome for small fixes. Broader ideas can be opened for discussion in the Discussions forum.
A list of things that I hope to have implemented in the future.
If you found this software useful, please consider buying me a coffee on Kofi. Every contribution helps me to make more software:
