Cherry Tree

Introduction  [Top]

There are a lot of patches for the RPG Maker out there. But there are also many incompatiblities and other problems. At the end nobody really knows what’s the best way to solve a foreign problem.

With the CGSS, I am now trying to create a platform where it’s easy to build extensions for the RPG Maker upon. The CGSS is scripting system which is using Lua. It should let you modify and/or extend the RPG Maker with scripts, similar to the RGSS used in RPG Maker XP/VX.

In contrast to previous patches, in the CGSS everything is transparent. Except a “Kernel” object, which allows interaction with the RPG Maker on a very low level, the CGSS is written completely in Lua, and well commented. Before the game is starting, a Lua script is executed, in which the CGSS is initialized. Then, it’s possible to switch between RPG Maker code and Lua scripts using “Callbacks” installed in that initialization script.

For the simple RPG Maker user, the integration of modification is made a lot easier through the concept of “Userscripts”. He only needs to download a script from the internet, modify the settings if necessary and then copy it into a special folder – it’s instantly integrated into the game. For programmers this creates a new world of infinite possibilities, because you can write scripts by yourself, of course.

You can use any Lua libraries out there – there are a lot, from a network library to a 3D library, you’ll find everything. You can also write one by yourself, if you are able to.

However, the CGSS only works with 2 versions of the RPG_RT.EXE file (RM2000 v1.07 and RM2003 v1.08), but this can theoretically be extended later. But I have the most information about this two, which makes integreation quite easy for me. Other versions should not even be necessary, because in theory, you will be able to build all missing features by yourself using the CGSS.

The testing demo  [Top]

To understand the operation and the possibilities of CGSS, the easiest way is to see an example. Although the development is at a very early state, I have created a small testing demo, where a userscript is demonstrated, which allows easy keyboard and mouse input (partly like Power Mode 2003). At the moment, no more ways of interaction with the game than access to switches and variables are implemented.

For a quick overview you should first start and test the demo, then view it in the RPG Maker and look into the file “Script\Userscripts\basic_keyboard_and_mouse_input.user.lua”.

You can get the download here: CGSS Testing Demo v0.00a1-testing

Documentation  [Top]

At the moment, there is no proper documentation (except the comments in the scripts). A detailed documentation will follow soon.