Can't create custom title screen module on v4

turupawn

Hello, I'm trying to create my own module derived from the title-screen plugin on v4. However it errores by saying: The GUI named rpg-title-screen is non-existent. Please add the component in the gui property of the decorator @RpgClient on the browser console. If I import from npm it works fine.

This is exactly what I did. First I created a new project:

npx degit rpgjs/starter#v4 my-rpg-game
cd my-rpg-game
npm install

Then I copy pasted the plugin from the main repo into the root of mine, like this:
https://github.com/Turupawn/RPGJSv4Test/tree/master/title-screen

Then I modified the .toml file like this:
https://github.com/Turupawn/RPGJSv4Test/commit/540a8050fe47a5cf001f9d75ce78d0580d0a8799#diff-9622cbee5bb96bf7d6a28b4e2e13258f0dabc5852759a7e4f5b76d2d91ef7f72

I notice the title-screen/src/client/index.ts file is not being called (if I console log, can't see it on the browser console).What else should I do/what am I missing?

I'm new to rpgjs and I really love it. Very happy to see the v4 launch!
Cheers!

Samarium

Hello and welcome,

If you put a package in modules de rpg.toml, it will look for the package.json.

This is not the case here.

Nevertheless, I think it would be interesting to add this point to improve compatibility

turupawn

I see, thanks for your quick reply. It did helped me. I was able to make my custom title screen by adding to the modules folder as usual.

Btw, we're doing a web3 lottery every week or so where we raffle eth and an NFT from an artist of our local community. We have been doing it locally in-person but we want to do it online too with the help of rpg.js. So last thursday we beta tested doing the raffle on rpg.js and besides a few bugs on our side here and there it went well. We'll continue doing tests and continue building. I might do a different thread on this but the current build is published here, it works on optimism mainnet: http://68.183.123.1:3000/

Going back to the modules library. I want to build a couple of web3 wrapper libraries to make it easier to integrate on other web3 games. So I thought I could start by publishing a web3 title screen module on npm. Any recommendation on how to achieve this, as in documentation or examples. Or do you know if anyone else is doing something similar so I can contribute there instead?

This was the title screen connected to web3 that we used last thursday
lfg

Samarium

turupawn

Hello,

Thank you for your feedback.

To publish a module, you can follow the same structure as:

https://github.com/RSamaium/RPG-JS/tree/v4/packages/plugins/title-screen

1) The config.json file at the root indicates what the developer must (or can) put in rpg.toml. You can then retrieve a configuration (server-side, client-side or both) from the module.

Example:

{
    "namespace" : "web3",
    "server" : {},
    "client" : {
        "type" : "objet",
        "properties" : {
            "provider" : {
                "type" : "string"
            }
        },
        "required" : [
            "provider"
        ]
    },
    "*" : {}
}

So in rpg.toml,

you can set

[web3]
   provider = '...'

In code, you can find the configuration with: https://docs.rpgjs.dev/api/RpgClientEngine.html#globalconfig

2) When you publish to npm, publish it prefixed with rpgjs- .the compiler will understand that it's a plugin.

encanto

turupawn absolutely looking for this. did you ever go through?