Creating sbslibs

[astrolamb-gaming]

I'm trying to make a sbslib separate from sbs_utils, mostly just to understand the process. But I seem to be encountering difficulties in getting Cosmos to load it properly.

I have a root mission folder, test_non_sbs, with the following contents:

This mimics the sbs_utils folder structure as best I can tell, and I'm not aware of any other required files.

Inside of __lib__.json:

{
    "version": "v0.0.1",
    "sbslib": [
        "test_non_sbs"
    ]
}

Inside of testing_sbs.py, I have this:

from sbs_utils.mast.mast_globals import MastGlobals
# This should add `testing_my_non_sbs()` as a global function
MastGlobals.import_python_module("test_non_sbs.contents.contents")

And in contents.py, just a test function:

def testing_my_non_sbs():
    print("Testing my non-sbs sbslib")

I've added the sbslib name to story.json for LegendaryMissionsDev with sbs_utils.

But when the function is called, I get a MAST error saying that "testing_my_non_sbs" is not defined.

I've tried changing the directory structure (with appropriate reference changes), changing where the import function is called, and probably a lot of things I can't remember, but no dice. What am I missing?

[dougreichard]

This works for me.

Did you create an __lib__.json in the source for the sbslib?
Did you build an sbslib file, and is it in __lib__?
Did you also include the reference to the library in story.json of the missions that uses the library?
Did you import testing_sbs.py in any mast files?

I added a __lib__.json (note: The sbslib name needs to match the mission folder name which it looks like you did.)

{
    "version": "1.0",
    "sbslib": [
        "quick_example"
    ]
}

I build and have a artemis-sbs.quick_example.1.0.sbslib in __lib__.

sbs lib quick_example

If you do not have the sbs tool. Get it here and read about it here

I made sure I have the lib in my story.json

{
    "sbslib": [
        "artemis-sbs.sbs_utils.v1.3.0.sbslib",
        "artemis-sbs.quick_example.1.0.sbslib"
    ]
}

I create a file to boot strap adding it to globals test.py.

from sbs_utils.mast.mast_globals import MastGlobals
MastGlobals.import_python_module("quick_example.test")
print("Importing test.py")

I imported the test.py in a mast file. In my case it was a __init__.mast

import test.py

I was able to use the function fine.

# in some mast file 
test_func("Hello")

[astrolamb-gaming]

The import_python_module part is probably the clunkiest part. Since you have to do it in the consuming mission.

I'll have to consider if there is a more automated way of doing this.

Your testing_sbs.py seems to be in the library, mine is not. Mine is in the consuming mission.

This is why it wasn't working for me; I added a function in the mission that imported the module, and it works.
How is sbs_utils loaded? I suppose it is loaded from the mission's script.py.

[dougreichard]

There is a magic little file in the PyAddons folder for Cosmos. sbslibs.py That is where it looks for all the sbslib files to load.

In script.py you will see a import sbslibs That is how the magic happens.

[astrolamb-gaming]

sbslibs.py should load ALL the sbslibs though, or at least adds them to the path. So isn't it script.py that actually initializes everything?

[dougreichard]

sbslibs.py looks in the missions for its story.json and only loads the ones specified there, as it should.
Yes it just adds them to the path, and then to use anything you have to import them (i call that bootstrapping).

So, yes script.py is the thing importing sbs_utils.mast etc.

   import sbslibs
   from sbs_utils.handlerhooks import *
    from sbs_utils.gui import Gui
    from sbs_utils.mast.maststorypage import StoryPage
    from sbs_utils.mast.mast import Mast

Those import do bootstrap every thing needed for mast etc.
That is why you need to bootstrap your sbslib.

I think the easiest thing to do is add expose import_python_module so you can just call it from mast.
As well as add some code to avoid reimporting that module just to save some performance with multiple calls.

I'll do that now.

[dougreichard]

This should now work in MAST.

import_python_module("quick_example.test", "quick_example_test")
quick_example_test_test_func(" Hello, direct from MAST")

Note that I added the prefix. Which I think is just good practice. albeit my function name looks wierd with 'test_test'

Prefixes are up to you, so it could be shortened to qet_test_func by using the prefix qet.