Skip to content

Latest commit

 

History

History
124 lines (78 loc) · 4.97 KB

README.md

File metadata and controls

124 lines (78 loc) · 4.97 KB
Raw

CodeQL

What is this

This Program lets you add a Project to the Deprecated Twitch Developer Rig.

It comes with no warranties so if you break something it's your fault If you do so it's at your own risk!

Functions

  • Import a Project - Create a Project Manifest file from a Developer Console Extension and add that project to Rig for use
  • Refresh Manifest - Update a Project Manifest file from a Developer Console Extension
  • Reopen Project - Open a Project Manifest file and (re)add that project to the Rig for use

Quick Start Usage Instructions

Read the Blog Post or this quick start:

New Users

  1. Install The Rig
  2. Install this program
  3. Open the Rig
  4. Login to Twitch in the Rig
  5. Close The Rig
  6. Create an Extension on the Dev Console if you didn't already
  7. Open this program
  8. Fill in the fields under "Import a Project" from the Dev Console for the Extension you want to import
  9. Click "Attempt Create"
  10. Open the Rig

You should now have your project in the Rig ready to work with.

Existing Users

  1. Close the Rig
  2. Open this program
  3. Run the required function you need populating fields if needed
  4. Open the Rig

Technically you can leave this Program open, as it opens/closes the Rig internal Database as needed.

Common Issues

  • Database not open - you left the Twitch Developer Rig open, and the Manifester is locked out. Close the Twitch Developer Rig, optionally restart the manifester.

Installation and Updates

This is an Electron App, so it maybe installed from the GitHub releases tab.

The Windows Build is Code Signed with the Publisher Barry Carlyon The Mac Builds are Code Signed with Apple Cerficates that identify Barry Carlyon

You can download the latest version, for Windows from here on GitHub under releases. These builds will self update

Uninstallation

You can use Windows "Add and Remove Programs" to uninstall the program.

Data/Config Storage

This app doesn't store/save any of your data but it may leave a folder behind

Windows:

%appdata%/BarryCarlyonDeveloperRigManifester/

Mac DMG/Manual install:

~/Library/Application Support/BarryCarlyonDeveloperRigManifester/

Notes

  • Uses Electron to provide as a Desktop App
  • Uses Bootstrap for primary layout
  • Uses GitHub for update delivery and code management
  • JWT tokens are generated inside the App via auth0/node-jsonwebtoken, as apposed to "ClientSide" like this example
  • A number of sindresorhus Electron Modules.
  • Uses ClassicLevel to interact with the Developer Rig database/LocalStorage.

For a project to exist in the Rig, two components need to exist.

  • The manifest/project file which is a local copy of your selected Extension Settings/integration slots/testing baseURI/etc
  • An entry in the Extension Developer Rig database/LocalStorage, which holds your extension secret (which the Rig doesn't need any more anyway really), and a file/location reference to the project file so it can add it to the Developer Rig UI

Defined Extension views that you define are stored in the manifest/project file.

Warranty

If you break your Developer Rig from using this tool it's your own fault and the author(s) accept no responsbility for problems caused to your extension from using this tool.

License

This project is Licensed under Do What The F*ck You Want To Public License, so Just Do What the F*ck you want to!

Development Notes

This is an Electron Project

To run locally, after cloning, just

$ npm install
$ npn run start

Further Help with Twitch API

TwitchDev Discord

OMGLIEKWUT OHMYGOODNESS U SO MUCH HELP

Thank you for the help I want to give you beer/coffee money -> Check the Funding/Sponsor details