Skip to content

A template for typescript projects that uses manifest+ and auto creates versions using Github Actions

License

Notifications You must be signed in to change notification settings

League-of-Foundry-Developers/foundry-typescript-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Changelog

Please for the love of all that you hold dear, do everyone a favor and include a changelog here rather than making people guess at the capabilities of your module since last release

Description

This is a typescript template to get you started. This is not intended for beginners.

Please use the javascript template as necessary for your stuff.

Manifest Plus

Adds the following fields to the manifest for package browsers to pick up and show information better:

- includes: [] # list of files to include in the zip
- icon: "" # link to icon img
- cover: "" #link to cover img
- screenshots: [] #links to screenshot images
- video: ""
- authors: [
  {
    "name": "name",
    "email": "email",
    "discord": "discord"
  }
]

Versioned Releases

The Github Actions script will automatically create a Latest release which will always have a module.json that points to the latest release, and a versioned release whenever you update the version in your module.json.

This allows people who depend on a specific version of your module to just install that and be version locked. The versioned releases will not auto update.

License

MIT License. Do what you will. PRs welcome.