Skip to content

Components

Jump to bottom
Kytten edited this page Sep 10, 2022 · 5 revisions

Components are a powerful tool enabling you to write custom commands, scripts, and more. Anyone with any kind of Python experience can write their own components to add new features!

Components are only supported on Windows systems

You can get a list of currently-installed components and their status by using the components command. In addition, you can use this command to directly manage your components, using the various options. To learn more about the command and its options, use the man components command.

Install a new component

  1. Create a new python file in the :/ProgramData/winLine/components/ directory. Make sure the file name is structured like this: command_name.py, as you'll type the file's name as its run command. .pyw, .pyc, .pye, and .pyj files are not currently supported
  2. In the new python file, write your code. SAVE the file
  3. To enable the new component, restart WinLine with the term -r command

Uninstall a component

  1. In WinLine, run the components command. You'll get a list similar to the one in this image: list of components
    For this example, we'll walk through the steps to uninstall the shoutout component
  2. We need to disable the component first. To do this, run the components --disable shoutout command
  3. Now, we can uninstall the component. To do this, run the components --purge shoutout command

If everything went well, the components command shouldn't list the uninstalled component anymore. However, it might be listed as "UNLOADED". If this is the case, you should restart WinLine and re-run the components command.

WARNINGS: PLEASE READ

Components are and extremely powerful tool. If a component is malicious, it could cause serious damage to your system. For this reason, components are not allowed to run until their command is called, and they can be temporarily disabled to prevent accidental running.

If you find a component you don't recognize, you should uninstall it immediately. You should never install components from an unknown or untrusted source!

This is a list of all components that might ship with WinLine by default:

  • camx
  • install-sc
  • share-screen
  • shoutout
  • stress
  • stress_ram

These are additional components that ship with WinLine Developer by default:

  • build_winline
  • reset_winline
Clone this wiki locally