Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aso20455 authored and Aniket-Engg committed Jan 7, 2025
1 parent 5c80a9d commit 2296ff6
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions apps/remixdesktop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const clientProfile: Profile = {

As you can see in the clientProfile you define the methods which are exposed to the Remix plugin system.

5. add a base plugin and a plugin client
4. add a base plugin and a plugin client
```
export class CompilerLoaderPlugin extends ElectronBasePlugin {
clients: CompilerLoaderPluginClient[] = []
Expand All @@ -71,7 +71,7 @@ The ElectronBasePluginClient is the specific instance which will be connected to

Any instance specific code is set as functions on the ElectronBasePluginClient class.

6. If you need fs access you need to track the workingdir like we do here:
5. If you need fs access you need to track the workingdir like we do here:
This ensures you know where the user is working

```
Expand All @@ -92,7 +92,7 @@ class IsoGitPluginClient extends ElectronBasePluginClient {
```

7. If you need to call methods on the BASE which holds all the clients you can add methods there, for example this iterates over clients
6. If you need to call methods on the BASE which holds all the clients you can add methods there, for example this iterates over clients
and finds the one with the webContentsId. This ID passed on ie by menu items. Look at menu.ts to see how that works.

```
Expand All @@ -104,29 +104,29 @@ and finds the one with the webContentsId. This ID passed on ie by menu items. Lo
}
```

8. Add your plugin to engine.ts
7. Add your plugin to engine.ts

```
const compilerLoaderPlugin = new CompilerLoaderPlugin()
```

9. Register the plugin in engine.ts
8. Register the plugin in engine.ts

```
engine.register(compilerLoaderPlugin)
```

10. activation of plugins is done when the clients connect to the engine. No need to activate it.
9. activation of plugins is done when the clients connect to the engine. No need to activate it.

11. Add the plugin to the preload.ts. Add it to this list:
10. Add the plugin to the preload.ts. Add it to this list:

```
const exposedPLugins = ['fs', 'git', 'xterm', 'isogit', 'electronconfig', 'electronTemplates', 'ripgrep', 'compilerloader', 'appUpdater']
```

If you don't do this, it won't work.

12. In Remix IDE create a plugin in src/app/plugins/electron. If everything works correctly the methods will be loaded from the electron side, no need to specify them here.
11. In Remix IDE create a plugin in src/app/plugins/electron. If everything works correctly the methods will be loaded from the electron side, no need to specify them here.
This plugin is only a passthrough.

```
Expand All @@ -150,11 +150,10 @@ export class compilerLoaderPluginDesktop extends ElectronPlugin {
}
```

13. if you need to activate that on load you need to add it to the app.js where other plugins are activated.
12. if you need to activate that on load you need to add it to the app.js where other plugins are activated.



## CI

CI will only run the builds if the branch is master or contains the word: desktop

0 comments on commit 2296ff6

Please sign in to comment.