pf2e-mobile-sheet

Make the PF2e Player Character sheet work on mobile

Localization

If you want to contribute to localization, you can help translate this on https://gitlocalize.com/repo/9335

If your language is missing, open an issue or contact me otherwise about it.

Installation

After installing the module, for using this module, I recommend you use Chrome and install foundry as a progressive web app by using "add to home screen".

For the best experience, disable the canvas on mobile clients (you may need to put your device into landscape to be able to use the settings menu, this will be fixed in a later version)

Development

Prerequisites

In order to build this module, recent versions of node and yarn are required. GNU make or a compatible program is recommended, as type generation is only set up to be done using Makefiles. Most likely, using npm also works, but only yarn is officially supported. We recommend using the latest lts version of node. If you use nvm to manage your node versions, you can simply run

nvm install

in the project's root directory.

You also need to install the project's dependencies. To do so, run

yarn install

make install

Building

You can build the project by running

yarn build

make

Alternatively, you can run

yarn build:dev

make build_dev

to watch for changes and automatically build as necessary.

Linking the built project to Foundry VTT

In order to provide a fluent development experience, it is recommended to link the built module to your local Foundry VTT installation's data folder. In order to do so, first add a file called foundryconfig.json to the project root with the following content:

{
  "dataPath": ["/absolute/path/to/your/FoundryVTT"]
}

(if you are using Windows, make sure to use \ as a path separator instead of /)

Then run

yarn link

make install

On Windows, creating symlinks requires administrator privileges, so unfortunately you need to run the above command in an administrator terminal for it to work.

You can also link to multiple data folders by specifying multiple paths in the dataPath array.

Regenerate types

Usually, the types included in this repo are already the up to date types. If you still want to generate up to date types, first add an entry to the foundryconfig.json file:

{
	"dataPath": "/absolute/path/to/your/FoundryVTT/Data",
	"pf2eRepoPath": "path/to/pf2e/system/repo"
}

Next, run

make reposetup_types

to set up everything for the first time, and to update your types again later, run

make default_types

Creating a release

The workflow works basically the same as the workflow of the League Basic JS Module Template, please follow the instructions given there.

Licensing

This project is being developed under the terms of the LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT for Foundry Virtual Tabletop.

This project is licensed under GPL-3.0-or-later.

The contents of many files are originally from the Mobile Improvements module under MIT License.

build-packs license:

The build-packs.ts script has taken from https://github.com/xdy/xdy-pf2e-workbench/blob/main/build/build-packs.ts and is, like the original, provided under the ISC license

project layout:

The Project layout has been copied over from https://github.com/xdy/xdy-pf2e-workbench and is licensed under the Apache License

OmegaRogue/pf2e-mobile-sheet