{"repo":"cclloyd/planeshift","free":true,"listed":false,"github":"https://github.com/cclloyd/planeshift","clone":"git clone https://github.com/cclloyd/planeshift.git","description":"A REST API for FoundryVTT","language":"TypeScript","stars":34,"topics":["api","foundryvtt","nodejs","rest-api","dnd","dungeons-and-dragons","nestjs","puppeteer"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"A REST API to make a FoundryVTT instance more accessible outside the game. Description PlaneShift is a REST API layer that connects to a running FoundryVTT instance, allowing you to access the game data in other apps easily. Discord and OIDC authentication are included by default, making it relatively simple to allow only your game users access to the API. For the API to be able to connect to your instance, you will need to create a player in the game, preferably called APIUser (case-sensitive) and a password. You can use your existing GM account if you wish, but you and the API can't be logged in at the same time. For this reason, it's recommended to create a dedicated user for the API. Key Features - OIDC/Discord authentication - API Keys for external services to access the API - Supports FoundryVTT v12, possibly other versions (untested) - Full docker support - An extensible evaluate endpoint allowing for anything in a running foundry game to be supported. Deployment Docker (recommended) A mostly ready to go docker-compose.yml file is provided. Full instructions can be found on the github wiki NodeJS If you want to just run by cloning this repo, you can run yarn build , then yarn start:prod:local to run the production build. A .env file can be provided in the current directory to load environment variables. Authentication Discord and generic OIDC providers are supported. You can also run without authentication, though that's not recommended. More info on setting up an auth","default_branch":null,"files":null,"tree":[],"storefront":"/r/cclloyd","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/cclloyd/planeshift/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}