Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rename and reorganize documentation files #165

Open
wants to merge 11 commits into
base: dev
Choose a base branch
from
147 changes: 88 additions & 59 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,69 +12,98 @@
*** xref:config/Serial.adoc[Serial Devices]
*** xref:config/Web.adoc[Web Server]

* xref:json/json.adoc[JSON]
* xref:json/json.adoc[API]

** xref:json/Read/Read.adoc[Read]

*** xref:json/Groups/getFactory.adoc[getAssembler]
*** xref:json/Read/getBelts.adoc[getBelts]
*** xref:json/Groups/getGenerators.adoc[getBiomassGenerator]
*** xref:json/Groups/getFactory.adoc[getBlender]
*** xref:json/Read/getStorageInv.adoc[getCloudInv]
*** xref:json/Groups/getGenerators.adoc[getCoalGenerator]
*** xref:json/Groups/getFactory.adoc[getConstructor]
*** xref:json/Groups/getFactory.adoc[getConverter]
*** xref:json/Read/getDoggo.adoc[getDoggo]
*** xref:json/Read/getDrone.adoc[getDrone]
*** xref:json/Read/getDroneStation.adoc[getDroneStation]
*** xref:json/Read/getDropPod.adoc[getDropPod]
*** xref:json/Groups/getFactory.adoc[getEncoder]
*** xref:json/Read/getResourceSink.adoc[getExplorationSink]
*** xref:json/Groups/getVehicles.adoc[getExplorer]
*** xref:json/Read/getExtractor.adoc[getExtractor]
*** xref:json/Groups/getVehicles.adoc[getFactoryCart]
*** xref:json/Groups/getFactory.adoc[getFoundry]
*** xref:json/Groups/getGenerators.adoc[getFuelGenerator]
*** xref:json/Groups/getGenerators.adoc[getGeothermalGenerator]
*** xref:json/Read/getHUBTerminal.adoc[getHUBTerminal]
*** xref:json/Groups/getFactory.adoc[getManufacturer]
*** xref:json/Read/getModList.adoc[getModList]
*** xref:json/Groups/getGenerators.adoc[getNuclearGenerator]
*** xref:json/Groups/getFactory.adoc[getPackager]
*** xref:json/Groups/getFactory.adoc[getParticle]
*** xref:json/Read/getPaths.adoc[getPaths]
*** xref:json/Read/getPipes.adoc[getPipes]
*** xref:json/Read/getPower.adoc[getPower]
*** xref:json/Read/getPlayer.adoc[getPlayer]
*** xref:json/Read/getPowerSlug.adoc[getPowerSlug]
*** xref:json/Read/getProdStats.adoc[getProdStats]
*** xref:json/Read/getRadarTower.adoc[getRadarTower]
*** xref:json/Read/getRecipes.adoc[getRecipes]
*** xref:json/Groups/getFactory.adoc[getRefinery]
*** xref:json/Read/getResourceNode.adoc[getResourceGeyser]
*** xref:json/Read/getResourceNode.adoc[getResourceNode]
*** xref:json/Read/getResourceSink.adoc[getResourceSink]
*** xref:json/Read/getResourceNode.adoc[getResourceWell]
*** xref:json/Read/getSchematics.adoc[getSchematics]
*** xref:json/Read/getSinkList.adoc[getSinkList]
*** xref:json/Groups/getFactory.adoc[getSmelter]
*** xref:json/Read/getSpaceElevator.adoc[getSpaceElevator]
*** xref:json/Read/getStorageInv.adoc[getStorageInv]
*** xref:json/Read/getSwitches.adoc[getSwitches]
*** xref:json/Groups/getVehicles.adoc[getTractor]
*** xref:json/Read/getTrains.adoc[getTrains]
*** xref:json/Read/getTrainStation.adoc[getTrainStation]
*** xref:json/Groups/getVehicles.adoc[getTruck]
*** xref:json/Read/getTruckStation.adoc[getTruckStation]
*** xref:json/Read/getWorldInv.adoc[getWorldInv]
*** xref:json/Read/getAll.adoc[getAll]

** xref:json/Write/Write.adoc[Write]
*** Factory

**** xref:json/Read/getFactory.adoc[getAssembler]
**** xref:json/Read/getBelts.adoc[getBelts]
**** xref:json/Read/getFactory.adoc[getBlender]
**** getCables (soon)
**** xref:json/Read/getFactory.adoc[getConstructor]
**** xref:json/Read/getFactory.adoc[getConverter]
**** xref:json/Read/getFactory.adoc[getEncoder]
**** xref:json/Read/getExtractor.adoc[getExtractor]
**** xref:json/Read/getFactory.adoc[getFactory]
**** getFrackingActivator (soon)
**** xref:json/Read/getFactory.adoc[getFoundry]
**** xref:json/Read/getHUBTerminal.adoc[getHUBTerminal]
**** getHypertube (soon)
**** xref:json/Read/getFactory.adoc[getManufacturer]
**** xref:json/Read/getFactory.adoc[getPackager]
**** xref:json/Read/getFactory.adoc[getParticle]
**** xref:json/Read/getPipes.adoc[getPipes]
**** getPortal (soon)
**** getPump (soon)
**** xref:json/Read/getRadarTower.adoc[getRadarTower]
**** xref:json/Read/getFactory.adoc[getRefinery]
**** getResourceSinkBuilding (soon)
**** xref:json/Read/getFactory.adoc[getSmelter]
**** xref:json/Read/getSpaceElevator.adoc[getSpaceElevator]
**** xref:json/Read/getSwitches.adoc[getSwitches]
**** getTrainRails (soon)

*** Generators
**** xref:json/Read/getGenerators.adoc[getBiomassGenerator]
**** xref:json/Read/getGenerators.adoc[getCoalGenerator]
**** xref:json/Read/getGenerators.adoc[getFuelGenerator]
**** xref:json/Read/getGenerators.adoc[getGenerators]
**** xref:json/Read/getGenerators.adoc[getGeothermalGenerator]
**** xref:json/Read/getGenerators.adoc[getNuclearGenerator]

*** Inventory
**** getCloudInv (soon)
**** xref:json/Read/getStorageInv.adoc[getStorageInv]
**** xref:json/Read/getWorldInv.adoc[getWorldInv]

*** Resource Nodes
**** xref:json/Read/getResourceNode.adoc[getResourceGeyser]
**** xref:json/Read/getResourceNode.adoc[getResourceNode]
**** xref:json/Read/getResourceNode.adoc[getResourceWell]

*** Session
**** xref:json/Read/getModList.adoc[getModList]
**** xref:json/Read/getPlayer.adoc[getPlayer]
**** getResearchTrees (soon)
**** getSessionInfo (soon)

*** xref:json/Write/setCircuit.adoc[setCircuit]
*** Sink
**** xref:json/Read/getResourceSink.adoc[getExplorationSink]
**** xref:json/Read/getResourceSink.adoc[getResourceSink]
**** xref:json/Read/getSinkList.adoc[getSinkList]

** xref:json/Groups/Groups.adoc[Groups]
*** Stations
**** xref:json/Read/getDroneStation.adoc[getDroneStation]
**** xref:json/Read/getTrainStation.adoc[getTrainStation]
**** xref:json/Read/getTruckStation.adoc[getTruckStation]

*** Vehicles
**** xref:json/Read/getDrone.adoc[getDrone]
**** xref:json/Read/getVehicles.adoc[getExplorer]
**** xref:json/Read/getVehicles.adoc[getFactoryCart]
**** xref:json/Read/getPaths.adoc[getPaths]
**** xref:json/Read/getVehicles.adoc[getTractor]
**** getTrains (soon)
**** xref:json/Read/getVehicles.adoc[getTruck]
**** xref:json/Read/getVehicles.adoc[getVehicles]

*** World
**** xref:json/Read/getDoggo.adoc[getDoggo]
**** xref:json/Read/getDropPod.adoc[getDropPod]
**** xref:json/Read/getPowerSlug.adoc[getPowerSlug]
**** xref:json/Read/getProdStats.adoc[getProdStats]
**** xref:json/Read/getRecipes.adoc[getRecipes]
**** xref:json/Read/getSchematics.adoc[getSchematics]

*** Power
**** xref:json/Read/getPower.adoc[getPower]
**** getPowerUsage

** xref:json/Write/Write.adoc[Write]

*** xref:json/Groups/getAll.adoc[getAll]
*** xref:json/Groups/getFactory.adoc[getFactory]
*** xref:json/Groups/getGenerators.adoc[getGenerators]
*** xref:json/Groups/getVehicles.adoc[getVehicles]
*** Factory
**** setSwitches (soon)
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/commands.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Any use of `< >` denotes an option or variable. For example: `<start/stop>` mean
== http

Usage: `/frm http <start/stop>`
Deperecated Command: `/frmweb <start/stop>`
Deprecated Command: `/frmweb <start/stop>`

Starts/stops the HTTP/WebSocket Server

== serial

Usage: `/frm serial <start/stop>`
Deperecated Command: `/frmserial <start/stop>`
Deprecated Command: `/frmserial <start/stop>`

Starts/stops the Serial/RS232 Port Handler

Expand All @@ -30,8 +30,8 @@ Intended for getting outputs of API Endpoints to save for future information or

=== info

Info will display back to the in-game chat, this is useful for quickly checking if JSON populates
Info will display back to the in-game chat, this is useful for quickly checking if JSON populates.

=== file

Info will be saved to the *host's* Debug folder located in the Remote Monitoring's Mod Folder
Info will be saved as file to the *host's* Debug folder located in the Remote Monitoring's Mod Folder.
9 changes: 0 additions & 9 deletions docs/modules/ROOT/pages/config.adoc

This file was deleted.

8 changes: 7 additions & 1 deletion docs/modules/ROOT/pages/config/config.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
= Configurations

:url-repo: https://github.com/porisius/FicsitRemoteMonitoring
:url-repo: https://github.com/porisius/FicsitRemoteMonitoring

Configuration for Ficsit Remote Monitoring

This will show the UI option as well as the FicsitRemoteMonitoring folder option for manual/headless changes.

See the Config Section for details.
7 changes: 6 additions & 1 deletion docs/modules/ROOT/pages/icons.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

:url-repo: https://github.com/porisius/FicsitRemoteMonitoring

Icons are extracted from the game upon game log, assuming that the server/client is not being a dedicated server AND the Concrete icon is not present.. This happens regardless of the Web Server/Socket & Serial Systems being active.
[WARNING]
====
Icons are not automatically generated on the dedicated server. Generate them with the client and copy the files to the Icons directory on your dedicated server.
====

Icons are extracted from the game upon game log, assuming that the server/client is not being a dedicated server AND the Concrete icon is not present. This happens regardless of the Web Server/Socket & Serial Systems being active.

This system is only available on the Web Server function and listens on the same port as the API. The URL is <Server IP/DNS>:<Port>/Icons/<Class Name of Item>.png, so for the default settings, connecting to the localhost, and using the Train icon the URL would be: `http://localhost:8080/Icons/Desc_Locomotive_C.png`

Expand Down
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@

:url-repo: https://www.github.com/porisius/FicsitRemoteMonitoring

[NOTE]
====
If you're using this mod on a dedicated server, each client must have SML installed.
Ficsit Remote Monitoring is not required on the client.
====

Ficsit Remote Management is a mod that is for statistical data collection and minor control via a Web Server/Socket and/or RS232/Serial Devices.
3 changes: 0 additions & 3 deletions docs/modules/ROOT/pages/json/Groups/Groups.adoc

This file was deleted.

Loading