starfield-ts-ml-screens
v0.3.2
Published
Screens allows you to put different `iframe`s on your screen. This allows you to put custom webpages floating all around your cockpit. Or a custom webpage showing in your pause menu, or inventory, or in a certain position.
Downloads
1
Readme
starfield-ts-screens
Screens allows you to put different iframe
s on your screen.
This allows you to put custom webpages floating all around your cockpit.
Or a custom webpage showing in your pause menu, or inventory, or in a certain position.
How does this works?
You need to create a configuration for it, and add it to the screen lists in config.yml
.
An example config would be:
screens:
- name: 'Name' # This is where you define the name. Must be unique
url: 'https://whatever.com' # The URL of your screen. Keep in mind that must allow iframes, but not all allows it. Google webpage wont work, but embded youtube videos will.
frameImage: 'https://whatever.com/frame.png' # This is the frame that would appear surrounding the screen. If you want super cool MFD frames, you can!
padding: 20 # This is the padding between the frame, and the screen. Basically how much the border size is
alpha: 1 # This is the alpha for the screen, in case you want holographic screens
hud: # This is a list of menus where this screen will appear. You can use this to filter cockpit only HUDs, player only HUDs, or even pause menus HUDs. If the HUD is in printAllMenus and visible, the HUD will appear.
- PausedMenu
- HUDMenu
hideInHud: # Same as above, but the opposite. If a game HUD on this list is being shown, the screen will hide. You can use a combination of both to get different results. On this config, for example, the HUD will appear anywhere except cockpit.
- SpaceshipHudMenu
size: # The size, in pixels of the screen
x: 250
y: 250
position: # The position where this screen is located. The Z controls the zIndex, in case you want screens appearing in top of others
x: 80
y: 10
z: 0
rotation: # 3D rotation of screens.
x: 20
y: 20
z: 0
cells: # Cells where this HUD will be shown
- cell: 'Jemison' # The cell name. On this example, all cells containing Jemison will trigger this HUD
position: # Use this to filter an exact position. On this case, if the player is near the position 0, 0, 0, will trigger this HUD
x: 0
y: 0
z: 0
distance: 100 # The distance where the player needs to be at maximum for this HUD to appear. You can put a really big number to disable the position filtering
Keep in mind that the URL must be IFrame compatible, and not all webpages allows to insert them into iframes