4883eb5a4e
updated to take account of the new map data tile sizes - show-more-portals no longer causes unfriendly request tile sizes. unclaimed are now visible one level further out, but l1+ is no longer available one level further in (i.e. it jumps directly from l2+ to all portals) - slow-less-portals-when-zoomed-out - major reductions in portal visibility levels - works around the daft tile size/zoom level combinations used in the current stock intel site
USER DOCUMENTATION MOVED!
The plugins list has been moved to the wiki. Please see there!
What follows is developer documentation only.
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. Read the common HACKING.md file for general tips and requirements.
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).