Godfinger scripting system

[2cwldys]

We have publicly released our modular script system, to better assist server owners to improve their creative works:
GitHub - MBII-Galactic-Conquest/godfinger: Godfinger is a modular script system that allows rcon hookup & plugin interaction to simplify serverside external scripting for MBII OpenJK in python.

 

[nomad.marshall]

good work and ty for sharing it

 

[blake_won]

Now this is the right approach to things, well done.

 

[nomad.marshall]

if i understand it correctly, this is close to (or pretty much is) just drag and drop, right? minimal set up needed on the user end beyond configuring what your modifiers are - vstr, rcon etc wise?

 

[2cwldys]

Yes, you install a compatible version of python, extract the code anywhere on the system, readme helps with majority of the steps, you install dependencies with prepare.bat, fill out the jsons (if there are any) if there isn’t you run start.bat to generate them, provide paths and rcon password. It works as a platform where you can create your own plugins as well as have them interact with each other as well as the imported server data the system handles from the log file.

I’ve made discord bots with this system, which notifies admins when someone needs support in the servers, tracks log for moderation purposes. As well as our entire Rock the Era systems tailored for the Supremacy project function entirely as their own plugin. It is a barebones system where you can hook up essentially anything, shell scripts, or your own implements, using exported server data.

Most server owners just throw on RTV and call it a day, we will work to update our own custom version for others to use, but essentially server owners can make anything they want now, within limitations, and run anything in sequential plugin form. Right now extracting and running it won’t do anything aside from immediately interpreting your log file, most people will have to make their own things with this system. Server owners can share their plugins they make amongst others, if they desire.

 

[2cwldys]

We have some important updates to this system, currently under the dev branch, which I'll elaborate on below:

1) Auto-update script, which prompts the user if they wish to update their installation to the latest origin/branch.
This ensures everyone running the system will get the latest features, as well as new global shared plugins, if any.

2) Portable GIT to update Godfinger for Windows users without having GIT installed.

3) Multi-platform support, with the help of debugging by Valzhar. The godfinger system should work on UNIX and MacOS systems.

4) Private codebase SSH deployment. More info in the readme.

5) Virtual environments, the Godfinger system now concentrates plugins and all implements into it's own /venv folders.
To protect your root system, as well as more UNIX support without having to use --break-system-packages with external dependencies.
venv — Creation of virtual environments


Keep in mind these changes are experimental, and are in no way replacements to using the main branch. This is a list of potential future features to come, making this hopefully become a more superior platform for running rcon and scripted implements alongside your mbiided server.

 

[2cwldys]

There are now significant updates to this system on the dev branch, which I will elaborate further on below.

1) Currently, ViceDice is working to wrap the mbiided process with pty pseudo-terminal interfaces. Right now only rcon logfile parsing is supported.

Spoiler: Code

    "interfaces":
    {
        "pty":
        {
            "target":"path/to/your/mbiided.exe",
            "inputDelay":0.001
        },
        "rcon":
        {
            "Remote":
            {
                "address":
                {
                    "ip":"localhost",
                    "port":29070
                },
                "bindAddress":"localhost",
                "password":"fuckmylife"
            },
            "logFilename":"server.log",
            "logReadDelay":0.1,

            "Debug":
            {
                "TestRetrospect":false
            }
        }
    },
    "interface":"rcon",

2) We now have a git tracking plugin, users can see MBII textasset or script extension system changes live while playing on the server.
Additionally, on the event of godfingerEvent.GODFINGER_EVENT_TYPE_SERVER_EMPTY, with 0 players the server routinely checks for updates.. automatically building them with our package manager, as well as any private codebase deployments you may have and their latest HEAD. This is extremely hands free updating for servers at the whim of a single commit push... highly idealized for fast-paced development environments where typical RDP and WinSCP click and drag processes are simply too long...

Spoiler: Images

3) A TK manager plugin ported by ACHUTA, (TY Sandy) that allows you to mass TK reset everyone to 0 points in the server through RCON, admins may use smod smsay !rtk or !resettk to incur upon this plugin...

4) You may now specify 7-digit commit hashes to use specific versions of the godfinger system, as well as specifying desired commit hashes similar for private deployments as well. The automated builder builds for latest always for live, but this is an excellent feature. This allows you to revert upon the event of any game-breaking updates, incompatible changes, or mistakes.

As always, there are more developments to come. We've not a ported version of RTV-RTM that is compatible, yet, but once done I guarantee the godfinger system will be one of the most influential and widespread to be used by the MBII community.

 

[2cwldys]

v1.0.1.1 of the Godfinger script extension system has released, with Windows & linux_MacOS support:

Release v1.0.1.1 · MBII-Galactic-Conquest/godfinger

This is the release 1.0.1.1 of the godfinger script extension system. 7z_portable.zip included internally for windows users, for portable git install. What's Changed [Refactor] obscured noinput ...

github.com

Additions:
- Gittracking plugin, which automatically builds for latest updates & checks for private SSH key & SVN posthook deployments,
- Soundboard plugin, which allows OnConnect, OnClientBegin, OnDisconnect, and OnMessage sounds,
- Ability to install SVN portably in your virtual environment and configure it to your %PATH% for windows machines,
- Ability to install SVN on UNIX systems if it is not installed,
- Quick starts for automated service providers, such as Ilyssa Hosting, or others.

Contributors:
- 2cwldys
- ViceDice
- ACHUTA/Mantlar,
- Valzhar