Sapphire - Imagine a framework•2y ago

Let's users have custom folders for pieces

As the title states, I think sapphire should let people place commands, listeners and interaction handlers...etc( all pieces ) in custom folders. Maybe sapphire should let people set the paths of those pieces in SapphireClientOptions.

Solution:

Already possible. You can register a path for a store. If it is for a single store then use ```ts <this>.container.stores.get('mystore').registerPath('path/to/the/folder/here')...

Jump to solution

12 Replies

Solution

Favna•2y ago

Already possible. You can register a path for a store. If it is for a single store then use

<this>.container.stores.get('mystore').registerPath('path/to/the/folder/here')

<this>.container.stores.get('mystore').registerPath('path/to/the/folder/here')

If the path has subsequent folders of commands, listeners etc (i.e. a more DPy strategy of using cogs) then you can use

<this>.container.client.stores.registerPath('/path/to/folder/with/subfolders/here')

<this>.container.client.stores.registerPath('/path/to/folder/with/subfolders/here')

Ideally you would put these in an overloaded constructor of a SapphireClient, so something like:

export class MyCustomClient extends SapphireClient {
  public constructor(options: ClientOptions) {
    super(options);

    this.stores.get('interaction-handlers').registerPath(join(someDirWhereTheFolderIs, 'interactions'));
// or for cog system
    this.stores.registerPath(join(someDirWhereTheFolderIs, 'cog-module'));
  }
}

export class MyCustomClient extends SapphireClient {
  public constructor(options: ClientOptions) {
    super(options);

    this.stores.get('interaction-handlers').registerPath(join(someDirWhereTheFolderIs, 'interactions'));
// or for cog system
    this.stores.registerPath(join(someDirWhereTheFolderIs, 'cog-module'));
  }
}

Docs: https://www.sapphirejs.dev/docs/Documentation/api-pieces/classes/Store#registerpath and https://www.sapphirejs.dev/docs/Documentation/api-pieces/classes/StoreRegistry#registerpath

zewotwo12•2y ago

How

Favna•2y ago

yeah I was still getting links ill edit that msg

zewotwo12•2y ago

So you mean I can place my interaction-handlers in a folder named handlers?

ararou!•2y ago

if it extends InteractionHandler, probably i don't think it matters where you put it just as long it extends one of the classes

zewotwo12•2y ago

https://github.com/Greensky-gs/lofi-girl/blob/master/src/index.ts Something like this

GitHub

lofi-girl/index.ts at master · Greensky-gs/lofi-girl

Lofi girl bot's source code. Contribute to Greensky-gs/lofi-girl development by creating an account on GitHub.

zewotwo12•2y ago

Favna•2y ago

edited @Naryani Priya

zewotwo12•2y ago

Thanks

chillihero•2y ago

just to clarify for me, you can add helperfiles as pieces and the hmr will then reload this files on change too?

Favna•2y ago

If they're in a store, yes But that's not so much adding a custom folder for an existing store as it is creating your own new store Not to mention this PR is done and ready for review

Spinel•2y ago

GitHub Pull Request data for @Chillihero: <:_:864240877479657482> #415 in sapphiredev/plugins by favna opened <t:1675012551:R> feat: add utilities-store plugin

Gaming

Programming

Let's users have custom folders for pieces