Terminal tool (Windows & Unix type) for a specified wikibot. Under construction.
This terminal tool is supposed to be used for your wikibot control.
- When you first run your Wikibot Terminal Tool application copy, it will ask for basic statements:
- Wiki server host where your wikibot operates on (used for auhentication of the owner, to prevent griefing)
- Wikibot's main program class file URL (include full URL, including HTTP(S) protocol)
- Wikibot's functions and commands definitions JSON file URL (doesn't need to be used by bot, but is required by this terminal tool - read specification in
wiki, seesyntax.jsonfile for syntax)
- FROM THERE DOWN, THIS IS WHERE IMPLEMENTATION STILL HANGS ON
- If the configuration can't be saved (file corrupted, write permission denied, etc.), the app will store the configuration for current session. Next time when your run the program again, it won't remember these settings. If you want to save your configuration, make sure to check for write permission as well as read-only or corrupted file that needs to be deleted or unlocked in order to store your config. That file, named "config.cfg" sits in the same directory as program executable. You do not need to create the file, program will create it itself.
- After you set up your configuration, terminal checks for online status and starts listening for commands. Start with
logincommand, which will start login session. For safety reasons, your input is hidden from prompt lines in order to prevent login credentials theft from stalky people. However, check for keylogger in your software installs for full safety. If you accidentaly run the program, end the session usingquitcommand. - Login credentials are used for bot owner authentication. Only bot owner should know the login credentials of his bot.
- When login fails (incorrect login credentials), program asks you for login again. Number of login attempts is unlimited.
- Program checks for wiki server and bot script files online status (running or down) before commands listening. If the wiki server is down or bot script files are unreachable (unable to connect), program ends with a message to try again later.
- After successfully connected and logged in, you can write other commands (see
wiki/helpon GitHub repository for full details). - When you got all neccessary changes to your bot done, you can logout (simply use
logoutcommand, takes no parameters) - After logout or session end, program will halt command line with key press prompt. After key stroke, the program ends.
Take a look at the syntax.json file in the repository root. Learn the commented JSON code as a guide to make your own wikibot functions and commands JSON definition file. If you need more to look at, look at the example.json file for a quick lookup on how it should look like. The example file is a direct copy of my wikibot functions and commands definition. (In fact, wikibot isn't complete yet, it's just a concept and need to be consulted with more experienced programmers in Wikipedia)
Place this file in your online hosted repository for public access. It needs to be publicily accesible as the terminal tool doesn't know a way to access private parts of your wikibot script. The JSON file doesn't need to be part of actual wikibot, but it is recommended to be. You may implement functions separately using your own definition syntax. As a cherry on top of the cake, you may make the wikibot script generate new JSON definition as soon as definitions are updated. The JSON definition needs to be a single file, consisting of a single structure containing two main roots: functions and commands. These roots need to be named exactly like that. Functions and commands then take a form of lists containing structures with parameter name as a key and parameter type as a value. Parameter types are defined as regular binary data types (so int, long, short, byte, float, double, string, etc.).