-
Notifications
You must be signed in to change notification settings - Fork 12
Features
The main purpose of the plugin is to quietly record codes entries and other information which will be recorded in the Canonn API, The data is available for you to view and can be accessed through our API. Documentation for the API is available here
We will from time to time add features to the user interface to capture data that is not possible to capture through the logs, but you will be able to remove user interface elements that you do not wish to see.
Even with no visible user interface features you will still be helping Canonn to document the universe.
By default the user interface cycles through the last 9 news headlines from the canonn website. The news list is updated hourly. If you want to cycle through the news items faster then you can just click on "Canonn:" and it will display the next news item. You can click on the title to launch the website and view the news item.
The Canonn POI displays a nearby system of interest. Clicking on the patrol system name will take you to the EDSM page for the system. Clicking on the patrol description will take you to a web page specified by the patrol. This will often be a web form to fill in.
The green arrow to the right of the patrol will allow you to skip the system currently displayed and will show you the next on the list. Patrols that you have skipped will not be shown to you again unless you click on the left arrow.
If the patrol doesnt change when you click on the left button, then that means that it is the closest patrol to your current position.
The plugin will remember which patrols you have skipped between sessions with the exception of BGS Patrols and Ship Locations which are only remembered for the duration of the session.
The plugin will listen for commands when you send text through the in game message box. These will allow you to search for things of interest such as station services, system allegiance, and station economy. The search results will be displayed in the POI section of the window until you next jump. right clicking on the system name will allow you to copy to the clipboard.
examples:
-
nearest vista genomics
-
nearest cartographics
-
nearest repair
-
nearest black market
-
nearest federation allegiance
-
nearest Thargoid allegiance
-
nearest high tech economy
-
nearest rescue economy
Canonn patrols are often used for surveys or to simply direct you to things you may want to look at. If you can an idea for a patrol then please get in touch on our discord in #dev_and_website_support
You will need to set up a spreadheet with the following columns
- System Name
- Galactic X Coordinate
- Galactic Y Coordinate
- Galactic Z Coordinate
- Instructions: What to do when you get there
- Url: You can use the {CMDR} placeholder and we will fill in the commander name
- Event: This needs to be an event that will trigger the completion of a patrol in json format eg {"event": "FSSAllBodiesFound"}
Canonn Patrols can be turned off.
BGS Patrols show you where the nearest system with Canonn influence is located. If you find yourself nearby please drop in and sell your exploration data or run some missions. If the system has not been updated in a while, please jump in so that we can get up to date BGS data.
BGS can be turned off in the settings page.
When you begin a hyperspace jump the plugin will check the database for sites of interest during the jump and will display icon representing the different kinds of things you should see in system. Hover over the icon to see what things can be found on which bodies. It will also show you how many bodies remain to be scanned in EDSM if the system hasn't been fully scanned.
The canonn capture system is a text command that can be send in the communication window of the game to store your current status.json in our database. The main use case for this is for surveys where you want to capture lat/long and/or heading data for particular landmarks. It also captures system, coordinate and body if appropriate
examples:
Sending "canonn capture" on its own will just store the status.json with no comments Sending "canonn capture some text" will store the status.json with the comment "some text"
You can also specify some keywords and an site id following the "canonn capture" command.
Sending "canonn capture biology 1 some text" will store the status.json with the category "biology" and the site id. It will also store the comment "some text"
The data will be loaded into spreadsheets at some point in the near future.