2.4 KiB
Plugins
Install
Plugins are installed the same way the total conversion script is. Please see there for specific instructions for your browser.
Available Plugins
- Guess Player Level looks for the highest placed resonator per player in the current view to guess the player level.
- Highlight Weakened Portals fill portals with red to indicate portal's state of disrepair. The brighter the color the more attention needed (recharge, shields, resonators). A dashed portal means a resonator is missing.
- Draw Tools allows to draw circles and lines on the map to aid you with planning your next big field.
Hacking
Plugins may be developed in the same way as the total conversion script. Plugins may provide features tailored to specific needs and are allowed to change things as they see fit. You can provide them separately or submit a pull request to have them managed in this repository. If you think a hook in the main script is required, simply open a bug report.
You can use the guess player level script as an example to get you started. Just update the names and the part between // PLUGIN START and // PLUGIN END and you should be able to develop your plugin. The other code ensures your plugin is executed after the main script.
If you happen the write general purpose functions for your plugin, consider adding them to the main script instead. For example, if you write a getResoCountFromPortal(details) function it may be very well added to code/portal_info.js.
External Dependencies
If you have external dependencies put them into external/ and add a version number to their filename. I will put them in dist/ once required. Don’t forget to add a note about author and license in main README.md.
Available Hooks
Available hooks are documented in the code. Please refer to the boilerplate explanation in hooks.js to see which are available and how to listen for them. If you need additional hooks, open bug reports (preferably with patches attached).