generated from laquasicinque/FoundryVTT-Module-Template
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8c97823
commit 2cfae6f
Showing
2 changed files
with
14 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,18 @@ | ||
|  | ||
| <!--- Downloads @ Latest Badge --> | ||
| <!--- replace <user>/<repo> with your username/repository --> | ||
| <!---  --> | ||
| # Monaco Macro Editor | ||
|
|
||
| <!--- Forge Bazaar Install % Badge --> | ||
| <!--- replace <your-module-name> with the `name` in your manifest --> | ||
| <!---  --> | ||
| This module adds the [Monaco Editor](https://github.com/Microsoft/monaco-editor) (the editor used in VS Code, as well as other online editors) as the macro editor in Foundry, allowing users to use a slightly slimmed down version of the editor within foundry itself. It also adds [types](https://github.com/League-of-Foundry-Developers/foundry-vtt-types) provided by the League Of Foundry Developers to allow for a nicer scripting experience from within Foundry itself. | ||
|
|
||
| A thing to note about the module, whilst the Monaco Editor is very powerful, it could be a bit too heavy for those who are on a weaker machine, in which case I'd recommend using the [Ace Macro Editor](https://foundryvtt.com/packages/macroeditor) instead. | ||
|
|
||
| # How to use this Template to create a versioned Release | ||
| ## For Library/Module Developers | ||
|
|
||
| 1. Open your repository's releases page. | ||
|
|
||
|  | ||
|
|
||
| 2. Click "Draft a new release" | ||
|
|
||
|  | ||
|
|
||
| 3. Fill out the release version as the tag name. | ||
|
|
||
| If you want to add details at this stage you can, or you can always come back later and edit them. | ||
|
|
||
|  | ||
|
|
||
| 4. Hit submit. | ||
|
|
||
| 5. Wait a few minutes. | ||
|
|
||
| A Github Action will run to populate the `module.json` and `module.zip` with the correct urls that you can then use to distribute this release. You can check on its status in the "Actions" tab. | ||
|
|
||
|  | ||
|
|
||
| 6. Grab the module.json url from the release's details page. | ||
|
|
||
|  | ||
|
|
||
| This `module.json` will only ever point at this release's `module.zip`, making it useful for sharing a specific version for compatibility purposes. | ||
|
|
||
| 7. You can use the url `https://github.com/<user>/<repo>/releases/latest/download/module.json` to refer to the manifest. | ||
|
|
||
| This is the url you want to use to install the module typically, as it will get updated automatically. | ||
|
|
||
| # How to List Your Releases on Package Admin | ||
|
|
||
| To request a package listing for your first release, go to the [Package Submission Form](https://foundryvtt.com/packages/submit) (accessible via a link at the bottom of the "[Systems and Modules](https://foundryvtt.com/packages/)" page on the Foundry website). | ||
|
|
||
| Fill in the form. "Package Name" must match the name in the module manifest. Package Title will be the display name for the package. Package URL should be your repo URL. | ||
|  | ||
|
|
||
|
|
||
| One of the Foundry staff will typically get back to you with an approval or any further questions within a few days, and give you access to the package admin pages. | ||
|
|
||
| Once you have access to the [module admin page](https://foundryvtt.com/admin/packages/package/), you can release a new version by going into the page for your module, scrolling to the bottom, and filling in a new Package Version. | ||
|
|
||
| When listing a new version, Version should be the version number you set above, and the Manifest URL should be the manifest __for that specific version__ (do not use /latest/ here). | ||
|  | ||
|
|
||
| > ### :warning: Important :warning: | ||
| > | ||
| > It is very important that you use the specific release manifest url, and not the `/latest` url here. For more details about why this is important and how Foundry Installs/Updates packages, read [this wiki article](https://foundryvtt.wiki/en/development/guides/releases-and-history). | ||
| Clicking "Save" in the bottom right will save the new version, which means that anyone installing your module from within Foundry will get that version, and a post will be generated in the #release-announcements channel on the official Foundry VTT Discord. | ||
|
|
||
|
|
||
| # FoundryVTT Module | ||
|
|
||
| Does something, probably | ||
|
|
||
| ## Changelog | ||
| To make it easier to add new typings for other modules and libraries to foundry, a hook provides a function to register types. the register function takes a fake filepath and the typescript file as a string. | ||
| ```ts | ||
| Hooks.on("monaco-editor.ready", (registerTypes) => { | ||
| registerTypes("module-name/index.ts", ` | ||
| declare class Foo { | ||
| bar (): string | null | ||
| } | ||
| `) | ||
| }) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters