Skip to content

dovrosenberg/fvtt-template

Repository files navigation

What this is

The repo is a decent starting framework for creating an FVTT package. It's a collection of things I've used in other packages, so you'll need to change out names throughout.

Package name

Supported Foundry Versions

%%% Description here %%%

Feature requests?

Features

  • List of key features

How it works

  • Instructions, screenshots, etc.

Issues?

If you believe you found a bug or would like to post a feature request, head over to the module's Github repo and open a new issue.

Support

I'm happy to do this for free, as I primarily work on things I like to use myself. But if you'd like to buy me a root beer, I love knowing that people are using my projects and like them enough to make the effort. It's really appreciated!

Credits

Autocomplete Mentions is the result of the effort of many people (whether they know it or not). Please refer to CREDITS.md for the full list.

How to Contribute

You can build the project either with local node or using a dev container. In either case, make sure these environment variables are set:

FOUNDRYVTT_APP=<absolute path to your foundry installation>
FOUNDRYVTT_DATA=<absolute path to your foundry data directory>

npm install to get started.

npm run linkdata will create a symlink between the output directory and your foundry modules data. Then npm run debug will compile the project and update Foundry. You'll still need to activate the module in your game to test it.

Copyright and usage

THIS ENTIRE REPOSITORY IS COVERED BY THIS LICENSE AND COPYRIGHT NOTICE

Copyright 2023 Dov Rosenberg

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Starter template for new package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published