diff --git a/README.md b/README.md index a28aeca..e16400b 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ Firstly, you want to make a file called "meta.json" - it will let the module loa "start_on_boot": true, # tells mod loader to start your module automatically; false by default "version": 1, # this points to the specific version of modVM your code needs to run; 1 by default "alias": "testapp" # adds an alias to your module which can be later specified in control commands + "predefine": "predefine.py" # locates your predefine code (it is being run only once on module load } ``` @@ -44,5 +45,14 @@ After that you can start writing your code in the index.py file; every code is d - you can use modules already available to you (json, codecs); please, try to avoid importing unneccesary modules - if you need to access files amd folders in your module dicertory, you can easily do so by using self.path + "filename"; self.path always contains your current folder name - please, avoid using time.sleep() in any scenario; modules are syncronous, so usage of this method will stall the entire bot +- in order to define persistent variables you can set them in your predefine file -If you want to submit your code, please check if it works by running the bot and testing the output; if you want to submit the code for someone to do more work on it, you should set "start_on_boot" to "false" in meta.json file (the same should be done for testing/unstable modules) +If you want to submit your code, please check if it works by testing the output (see "testing" section below); if you want to submit the code for someone to do more work on it, you should set "start_on_boot" to "false" in meta.json file (the same should be done for testing/unstable modules) + +## Testing modules locally +In order to test the modules/bot offline you can run the module-testing.py file - it behaves just like the bot, but allows you to enter any message, doesn't require Internet connection and bot token. This is a good way to test your modules before publishing them. + +It can be used like this: +``` +python3 module-testing.py +```